Ja - 日本語

チャンネル

印刷する
共有
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 Key

リクエスト 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 Key

リクエスト 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 Key

リクエスト Bodyパラメータ

パラメータ	タイプ	必須有無	説明
name	String	Y	チャンネル名(最大: 90Byte)
type	String	Y	チャンネルタイプ(PUBLIC、PRIVATE)
translation	Boolean	N	自動翻訳の有無(true、false)
members	Object	N	PRIVATEチャンネルタイプである場合、参加可能な ID一覧
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	任意に指定できる固有 ID

参照

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 Key

リクエスト Pathパラメータ

パラメータ	タイプ	必須有無	説明
channelId	String	Y	チャンネル ID

リクエスト Bodyパラメータ

パラメータ	タイプ	必須有無	説明
name	String	N	チャンネル名
type	String	N	チャンネルタイプ(PUBLIC、PRIVATE)
translation	Boolean	N	自動翻訳の有無(true、false)
members	Object	N	PRIVATEチャンネルタイプである場合、参加可能な ID一覧
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	任意に指定できる固有 ID

参照

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 Key

リクエスト 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