Chat

Enter a channel

POST /api/channel/chat/{channelId}

요청한 채널ID에 해당하는 채팅방에 입장합니다.

(회원은 채널 입장 후 채팅이 가능합니다.)

Path Parameters

Name

Type

Description

channelId*

String

채널 Id

{
  "message": "채팅방 입장 완료"
}

Get a list of channel chat data

이전 채팅 내역 조회

GET /api/channel/chat/{channelId}

요청한 채팅방의 이전 채팅내역을 불러옵니다.

Path Parameters

Name

Type

Description

channelId*

String

채팅방 채널 ID

{
  "message": "채팅방 데이터 조회 완료",
  "ChatRoomChatListResponseDTO": [
    {
      "chatId": "long",
      "channelId": "string",
      "userId": "string",
      "email": "String",
      "contents": "String",
      "sendTime": "LocalDateTime",
      "updated": "boolean",
      "deleted": "boolean",
      "type": "String",
      "files": "List<String>",
      "originFiles": "List<String>",
    }
  ]
}

Create a direct chat room

개인채팅(DM)방 생성

POST /api/direct/chat/{receiverEmail}

요청한 receiverEmail과 소통할 수 있는 개인채팅(DM)방을 생성합니다.

Path Parameters

Name

Type

Description

receiverEmail*

String

받는 사용자 Email

{
  "message": "개인 채팅 방 생성 완료",
  "DirectRoomInfoResponseDTO": [
    {
      "roomId": "string"
    }
  ]
}

Enter a direct room

개인채팅(DM)방 입장

POST /api/direct/enter/{roomId}

요청한 roomId에 해당하는 개인채팅(DM)방에 입장합니다.

(회원은 채널 입장 후 채팅이 가능합니다.)

Path Parameters

Name

Type

Description

roomId*

String

개인 채팅방 ID

{
  "message": "성공"
}

Get a list of direct chat data

개인채팅(DM)방 이전 채팅 목록

GET /api/direct/chat/{roomId}

요청한 개인채팅(DM)방의 이전 채팅내역을 불러옵니다.

Path Parameters

Name

Type

Description

roomId*

String

개인 채팅방 ID

{
  "message": "개인 채팅방 채팅 목록 조회 완료",
  "DirectChatListResponseDTO": [
    {
      "chatId": "long",
      "channelId": "string",
      "userId": "string",
      "email": "String",
      "contents": "String",
      "sendTime": "LocalDateTime",
      "updated": "boolean",
      "deleted": "boolean",
      "type": "String",
      "files": "List<String>",
      "originFiles": "List<String>",
    }
  ]
}

Get a list of direct room data

개인채팅(DM)방 목록

GET /api/direct/{email}

요청한 회원이 소속되어있는 개인채팅(DM)방 목록과 채팅방의 알림 상태를 조회합니다.

Path Parameters

Name

Type

Description

email*

String

현재 사용자 email

{
  "message": "개인 채팅(DM)방 목록 조회 완료",
  "DirectListResponseDTO": [
    {
      "channelId": "string",
      "profileImage": "string",
      "receiveName": "string",
      "senderEmail": "String",
      "receiverEmail": "String",
      "notificationRead": "boolean",
    }
  ]
}

Upload a file

파일 업로드

POST /api/fileUpload

파일을 업로드하고 업로드한 파일의 URL을 반환해줍니다.

Request Body

Name

Type

Description

multipartfiles

MultipartFile

파일 data

{
  "message": "파일 등록 완료",
  "FileUrlListResponseDTO": [
    {
      "fileList": "List<String>",
      "fileUrlList": "List<String>"
    }
  ]
}

Get a list of notification

현재 알림 상태 목록

GET /api/notification/list/{email}

요청한 회원이 소속된 채널, 개인채팅(DM)방의 알림상태 목록을 반환합니다.

Path Parameters

Name

Type

Description

email*

String

사용자 email

{
  "message": "사용자 알림 상태 목록 조회 완료",
  "NotificationListResponseDTO": [
    {
      "channelId": "long",
      "workspaceId": "string",
      "notificationRead": "boolean"
    }
  ]
}

Update a LoggedAt

사용자 채널 로그 최신화

POST /api/notification/update

회원이 채널에 접속한 시간을 최신화합니다.

Request Body

Name

Type

Description

channelId*

String

채팅방 ID

type*

String

Chat Type

{
    // Response
}

Search chat contents

채팅 내용 검색

GET /api/search/chat/content

채팅방에서 검색 키워드를 기반으로 채팅 내을 검색합니다.

Query Parameters

Name

Type

Description

channelId*

String

채팅방 ID

searchContent*

String

검색할 내용

{
  "message": "채팅 내용 검색 성공",
  "ChatSearchInfoListResponseDTO": [
    {
      "chatId": "long",
      "channelId": "string",
      "contents": "string"
    }
  ]
}

PreviousChannel NextWeb Socket

Last updated 3 years ago

hashtagEnter a channel

hashtag채팅방 입장 및 Subscribe

hashtagPath Parameters

hashtagGet a list of channel chat data

hashtag이전 채팅 내역 조회

hashtagPath Parameters

hashtagCreate a direct chat room

hashtag개인채팅(DM)방 생성

hashtagPath Parameters

hashtagEnter a direct room

hashtag개인채팅(DM)방 입장

hashtagPath Parameters

hashtagGet a list of direct chat data

hashtag개인채팅(DM)방 이전 채팅 목록

hashtagPath Parameters

hashtagGet a list of direct room data

hashtag개인채팅(DM)방 목록

hashtagPath Parameters

hashtagUpload a file

hashtag파일 업로드

hashtagRequest Body

hashtagGet a list of notification

hashtag현재 알림 상태 목록

hashtagPath Parameters

hashtagUpdate a LoggedAt

hashtag사용자 채널 로그 최신화

hashtagRequest Body

hashtagSearch chat contents

hashtag채팅 내용 검색

hashtagQuery Parameters

Enter a channel

채팅방 입장 및 Subscribe

Path Parameters

Get a list of channel chat data

이전 채팅 내역 조회

Path Parameters

Create a direct chat room

개인채팅(DM)방 생성

Path Parameters

Enter a direct room

개인채팅(DM)방 입장

Path Parameters

Get a list of direct chat data

개인채팅(DM)방 이전 채팅 목록

Path Parameters

Get a list of direct room data

개인채팅(DM)방 목록

Path Parameters

Upload a file

파일 업로드

Request Body

Get a list of notification

현재 알림 상태 목록

Path Parameters

Update a LoggedAt

사용자 채널 로그 최신화

Request Body

Search chat contents

채팅 내용 검색

Query Parameters