Korean

채널

인쇄
공유
PDF

채널

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

채널에 대한 생성/수정/삭제하기 위한 API를 안내합니다.

전체 채널 조회 API

전체 채널을 조회할 수 있습니다.

요청 URL

GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels

요청 헤더

Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

요청 Query 파라미터

파라미터	타입	필수 여부	설명
filter	String	O	기본으로는 {} 입력하여 사용 부탁드립니다. 필터는 일부 필드에 대해서 검색이 가능합니다.
sort	String	X	정렬 하고자 하는 필드의 필터를 정의 합니다. ex) 내림차순 {"createdAt":"-1"} / 오름차순 {"createdAt":"1"}
option	String	X	옵션이 존재할 경우 아래를 참고하세요. ex) {"offset":0,"per_page":20}

요청 예시

curl -X 'GET' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels?filter=%7B%22state%22%3A%221%22%7D' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c14xxxxxxxxxxxxxxxxxxxx'

응답 예시 (정상)


[
  {
    "id": "5498fee1-bfdf-4d50-8017-xxxxxxxxxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxx",
    "name": "Channel-1",
    "user_id": "0e596be1-2ef0-4a79-a105-xxxxxxxxxxxxx",
    "user": {
      "id": "xxxxxxxxxx",
      "name": "Woody",
      "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
    },
    "unique_id": null,
    "type": "PUBLIC",
    "translation": false,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg",
    "created_at": "2023-03-14T18:07:14+09:00",
    "updated_at": "2023-03-16T16:18:42+09:00"
  },
  {
    "id": "14f11d8e-a092-4274-a6ba-e2a8ce4d77fb",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxx",
    "name": "Channel-2",
    "user_id": "0e596be1-2ef0-4a79-a105-xxxxxxxxxxxxx",
    "user": {
      "id": "xxxxxxxxxx",
      "name": "Woody",
      "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
    },
    "unique_id": null,
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": "https://cloudchat.gcdn.ntruss.com/samples/1.jpeg",
    "created_at": "2023-03-08T07:09:26+09:00",
    "updated_at": "2023-03-16T08:19:02+09:00"
  }
]

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

개별 조회 API

개별 채널을 조회할 수 있습니다.

요청 URL

GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/:channelId

요청 헤더

Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

요청 Path 파라미터

파라미터	타입	필수 여부	설명
channelId	String	Y	채널 ID

요청 예시

curl -X 'GET' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/:channelId' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c14xxxxxxxxxxxxxxxxxxxx'

응답 예시 (정상)

  {
    "id": "5498fee1-bfdf-4d50-8017-xxxxxxxxxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxx",
    "name": "CLOVA GreenEye",
    "user_id": "0e596be1-2ef0-4a79-a105-xxxxxxxxxxxxx",
    "user": {
      "id": "xxxxxxxxxx",
      "name": "User",
      "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
    },
    "unique_id": null,
    "type": "PUBLIC",
    "translation": false,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg",
    "created_at": "2023-03-14T18:07:14+09:00",
    "updated_at": "2023-03-16T16:18:42+09:00"
  }

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

채널 생성 API

채널을 생성할 수 있습니다.

요청 URL

POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels

요청 헤더

Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

요청 Body 파라미터

파라미터	타입	필수 여부	설명
name	String	Y	채널 이름 (최대: 90 Byte )
type	String	Y	채널 타입 (PUBLIC, PRIVATE)
translation	Boolean	N	자동 번역 여부 (true, false)
members	Object	N	PRIVATE 채널 타입일 경우 참여 가능한 아이디 목록
disabled	Boolean	N	채널 사용 여부 (true, false)
mutes	Boolean	N	채널 음소거 여부 (true, false)
push	Boolean	N	채널 푸시 여부 (true, false)
limit	Integer	N	채널 사용자 제한 수 (0: 무제한)
linkUrl	String	N	채널 링크 URL
imageUrl	String	N	채널 이미지 URL
uniqueId	String	N	임의로 지정할 수 있는 고유 아이디

참조

linkUrl 규칙 정의

도메인만 있으면 안됩니다.
대상 서버에서 리턴 Status를 200으로 해야 합니다,
Header 값이 존재해야 합니다
content-type 이 존재해야 합니다.

imageUrl

도메인만 있으면 안됩니다.
대상 서버에서 리턴 Status를 200으로 해야 합니다,
Header 값이 존재해야 합니다
content-type 이 존재하며 이미지 타입으로 리턴해야 합니다.

예시)

https://www.gitbook.com/cdn-cgi/image/width=40,dpr=2,height=40,fit=contain,format=auto/https://2238982255-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/spaces%2F-LNAM8Kjj1jpQoidHTej%2Favatar-1592576907682.png?generation=1592576908144636&alt=media

요청 예시

curl -X 'POST' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels' \
  -H 'accept: application/json' \
   -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c14xxxxxxxxxxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Name",
  "uniqueId": "unique Id",
  "type": "PUBLIC",
  "translation": true,
  "members": [],
  "disabled": false,
  "mutes": false,
  "push": false,
  "limit": 20,
  "linkUrl": "http://link_url",
  "imageUrl": "http://image_url"
}'

응답 예시 (정상)

 {
  "channel": {
    "id": "464d7a5d-1074-47da-9e6c-xxxxxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxx",
    "name": "Name",
    "user_id": "demo@itsb.io",
    "user": {
      "id": "TWVtYmVyczpkZW1vQGl0c2IuaW8=",
      "name": "User",
      "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
    },
    "unique_id": "unique Id",
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": null,
    "created_at": "2023-04-24T11:39:52+09:00",
    "updated_at": "2023-04-24T11:39:52+09:00"
  },
  "status": 1
}

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

채널 수정 API

채널 정보를 수정 할 수 있습니다.

요청 URL

PUT https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/:channelId

요청 헤더

Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

요청 Path 파라미터

파라미터	타입	필수 여부	설명
channelId	String	Y	채널ID

요청 Body 파라미터

파라미터	타입	필수 여부	설명
name	String	N	채널 이름
type	String	N	채널 타입 (PUBLIC, PRIVATE)
translation	Boolean	N	자동 번역 여부 (true, false)
members	Object	N	PRIVATE 채널 타입일 경우 참여 가능한 아이디 목록
disabled	Boolean	N	채널 사용 여부 (true, false)
mutes	Boolean	N	채널 음소거 여부 (true, false)
push	Boolean	N	채널 푸시 여부 (true, false)
limit	Integer	N	채널 사용자 제한 수 (0: 무제한)
linkUrl	String	N	채널 링크 URL
imageUrl	String	N	채널 이미지 URL
uniqueId	String	N	임의로 지정할 수 있는 고유 아이디

참조

linkUrl 규칙 정의

도메인만 있으면 안됩니다.
대상 서버에서 리턴 Status를 200으로 해야 합니다,
Header 값이 존재해야 합니다
content-type 이 존재해야 합니다.

imageUrl

도메인만 있으면 안됩니다.
대상 서버에서 리턴 Status를 200으로 해야 합니다,
Header 값이 존재해야 합니다
content-type 이 존재하며 이미지 타입으로 리턴해야 합니다.

예시)

요청 예시

curl -X 'PUT' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/464d7a5d-1074-47da-9e6c-xxxxxxxxxxxxxx' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546d261dxxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Name(Edit)",
  "uniqueId": "unique Id(Edit)",
  "type": "PUBLIC",
  "translation": true,
  "members": ["user001","user002"],
  "disabled": false,
  "mutes": false,
  "push": false,
  "limit": 20,
  "linkUrl": "http://link_url",
  "imageUrl": "http://image_url"
}'

응답 예시 (정상)

 {
  "channel": {
    "id": "464d7a5d-1074-47da-9e6c-xxxxxxxxxxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxxxxxx",
    "name": "Name(Edit)",
    "user_id": "demo@itsb.io",
    "user": {
      "id": "TWVtYmVyczpkZW1vQGl0c2IuaW8=",
      "name": "User",
      "profile": "https://profile_image_url"
    },
    "unique_id": "unique Id(Edit)",
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": null,
    "created_at": "2023-04-24T11:39:52+09:00",
    "updated_at": "2023-04-24T13:38:57+09:00"
  },
  "status": 1
}

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

채널 삭제 API

채널을 삭제 할 수 있습니다.

요청 URL

DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/:channelId

요청 헤더

Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

요청 Path 파라미터

파라미터	타입	필수 여부	설명
channelId	String	Y	채널ID

요청 예시

curl -X 'DELETE' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/464d7a5d-1074-47da-9e6c-xxxxxxxxxxxxxx' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546d261dxxxxxxxxxxxx'

응답 예시 (정상)

 {
  "channel": {
    "id": "464d7a5d-1074-47da-9e6c-xxxxxxxxxxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxxxxxx",
    "name": "Name(Edit)",
    "user_id": "demo@itsb.io",
    "user": {
      "id": "TWVtYmVyczpkZW1vQGl0c2IuaW8=",
      "name": "User",
      "profile": "https://profile_image_url"
    },
    "unique_id": "unique Id(Edit)",
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": false,
    "limit": 0,
    "link_url": null,
    "image_url": null,
    "created_at": "2023-04-24T11:39:52+09:00",
    "updated_at": "2023-04-24T13:38:57+09:00"
  },
  "status": 1
}

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

이 문서가 도움이 되었습니까?

What's Next

메시지

전체 채널 조회 API
응답
개별 조회 API
응답
채널 생성 API
응답
채널 수정 API
응답
채널 삭제 API
응답

태그

Ncloud Chat