Channel

Create a channel

채널 등록

POST /api/channel

요청된 field 값에 부합하는 채널을 생성합니다.

Request Body

Name	Type	Description
name*	String	등록할 채널
privateYn*	boolean	공개채널(F)/비공개채널(T) 구분
channelCode*	String	일반채널(CHAT)/화상채널(VIDEO) 구분을 위한 코드
workspaceId*	String	채널을 등록할 워크스페이스 ID

201: Created 채널 등록 완료

{
  "message": "채널 등록 완료",
  "id": "string"
}

404: Not Found 채널 등록 실패

Update a channel

채널 수정

PATCH /api/channel

요청한 채널ID 에 해당하는 채널의 이름을 수정합니다.

Request Body

Name	Type	Description
id*	String	수정할 채널 ID
name*	String	수정할 채널명

200: OK 채널 수정 완료

{
  "message": "채널 변경에 성공했습니다."
}

404: Not Found 채널 수정실패

Delete a channel

채널 삭제

DELETE /api/channel/{channelId}

해당 채널를 데이터베이스에서 소프트 삭제합니다.

Path Parameters

Name	Type	Description
channelId*	String	삭제할 채널 ID

200: OK 채널 삭제 성공

{
  "message": "채널 삭제에 성공했습니다."
}

404: Not Found 채널 정보가 존재하지 않음

Get a list of channel for user

소속 채널 목록 조회

GET /api/channel/list/{workspaceId}

요청한 워크스페이스에 로그인한 회원이 소속된 채널 목록을 조회합니다.

Path Parameters

Name	Type	Description
workspaceId*	String	조회할 워크스페이스ID

200: OK 채널 목록 조회 완료

{
  "message": "채널 목록 조회 완료",
  "channelGetResponseDTOList": [
    {
      "id": "string",
      "name": "string",
      "privateYn": boolean,
      "channelCode": "string"
    }
  ]
}

404: Not Found 조회 가능한 채널 정보가 없음

Get a list of public channel for user

소속 공개채널 목록 조회

GET /api/channel/list/public/{workspaceId}

요청한 워크스페이스에 로그인한 회원이 소속된 공채널 목록을 조회합니다.

Path Parameters

Name	Type	Description
workspaceId*	String	조회할 워크스페이스ID

200: OK 채널 목록 조회 완료

{
  "message": "채널 목록 조회 완료",
  "channelGetResponseDTOList": [
    {
      "id": "string",
      "name": "string",
      "privateYn": boolean,
      "channelCode": "string"
    }
  ]
}

404: Not Found 조회 가능한 채널 정보가 없음

Add users to channel

채널 멤버 등록

POST ​/api​/channel​/{channelId}​/member

이메일을 이용하여 여러 명의 회원을 채에 가입시킬 수 있습니다.

Path Parameters

Name	Type	Description
channelId*	String	가입할 채널 ID

Request Body

Name	Type	Description
emailList*	List<String>	채에 가입 이메일 리스트

201: Created 채널 멤버 등록 완료

{
  "message": "채널 멤버 등록 완료"
}

404: Not Found 채널 멤버 등록 실패

Remove user from channel

채널 멤버 삭제

DELETE ​/api​/channel​/{channelId}​/member?email={email}

채널 멤버에서 요청한 이메일을 사용하는 회원을 삭제합니다.

Path Parameters

Name	Type	Description
workspaceId*	String	회원을 삭제할 채 ID

Query Parameters

Name	Type	Description
email*	String	삭제할 회원 이메일

200: OK 채널 멤버 삭제 완료

{
  "message": "채널 멤버 삭제 완료"
}

404: Not Found 채널 멤버 삭제 실패

Search users for channel member registration

채널 멤버 등록을 위한 회원목록 검색

GET /api/channel/{channelId}/member/list?keyword={keyword}&seq={seq}

채널 멤버 등록을 위해 요청한 keyword, seq를 기반으로 회원목록을 검색합니다. 검색결과는 seq당 10개씩 반환합니다.

Path Parameters

Name	Type	Description
workspaceId*	String	검색할 채널 ID

Query Parameters

Name	Type	Description
keyword*	String	회원 이름을 검색하기 위한 검색어 키워드
seq*	int	검색결과 목록 순서

200: OK 채널 멤버 목록 조회 완료

{
  "message": "채널멤버 검색 완료",
  "channelName": "string",
  "channelMemberGetResponseDTOList": [
    {
      "email": "string",
      "name": "string",
      "statusCode": "string",
      "nickname": "string",
      "channelMemberCode": "string",
      "profileImage": "string"
    }
  ]
}

404: Not Found 조회 가능한 채널 멤버 정보가 없음

Search workspace members

채널 멤버 검색

GET /api/channel/{channelId}/member/search?keyword={keyword}&seq={seq}

채에 소속된 멤버를 요청한 keyword, seq를 기반으로 검색합니다.

Path Parameters

Name	Type	Description
channelId*	String	검색할 채 ID

Query Parameters

Name	Type	Description
keyword*	String	회원 이름을 검색하기 위한 검색어 키워드
seq*	int	검색결과 목록 순서

200: OK 채널 멤버 검색 완료

{
  "message": "채널멤버 검색 완료",
  "channelName": "string",
  "channelMemberGetResponseDTOList": [
    {
      "email": "string",
      "name": "string",
      "statusCode": "string",
      "nickname": "string",
      "channelMemberCode": "string",
      "profileImage": "string"
    }
  ]
}

404: Not Found 조회 가능한 채널 멤버 정보가 없음

Get a member code of user

채널 멤버 코드 조회

GET /api/channel/{channelId}/member/code

요청한 채의 멤버 권한을 조회한다.(ChannelMemberCode: CADMIN, CMEMBER )

Path Parameters

Name	Type	Description
channelId*	String	조회할 채 ID

200: OK 채널 멤버 코드 조회 완료

{
  "message": "채널멤버 코드 조회 완료",
  "channelMemberCode": "string"
}

404: Not Found 조회 가능한 채널 멤버 정보가 없음

Get info for a channel

채널 정보 조회

GET /api/channel/{channelId}/member/info

요청한 채널의 채널명과 채널 멤버 수, 채널코드를 조회합니다.

Query Parameters

Name	Type	Description
channelId*	String	정보 조회할 채널 ID

200: OK 채널 정보 조회 완료

{
  "message": "채널명 및 채널인원수 정보 조회 완료",
  "name": "string",
  "numOfPeople": int,
  "channelCode": "string"
}

404: Not Found 조회 가능한 채널 정보가 없음