チャンネルリストの照会

Classic/VPC環境で利用できます。

チャンネルリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/v1/api/channels

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`filter`	String	Required	絞り込み条件レスポンスボディの一部のフィールドに基づいて絞り込み完全一致する値のみ絞り込み条件がない場合、空の値`{}`を入力 <例> `{"id":"{チャンネル ID}"}`、`{"name":"{チャンネル名}"}`、`{"disabled":false}`
`sort`	String	Optional	ソートの基準 `{基準:方式}`形式で入力基準: レスポンスボディの Stringタイプフィールド方式: `-1` \| `1` `-1`: 降順 `1`: 昇順 <例> `{"createdAt":"-1"}`: 作成日時基準の降順
`option`	String	Optional	追加オプション: Option <例> `{"offset":0,"per_page":20}`: 最初の項目から20個表示

Option

Optionの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`offset`	Number	Optional	照会開始点 0~N
`per_page`	Number	Optional	ページごとの項目数 1~100
`count`	Boolean	Optional	リストの代わりにレスポンス結果数を表示するか `true` \| `false` `true`: レスポンス結果数を表示 `false`: リストを表示

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels
?filter=%7B%22type%22%3A%22PUBLIC%22%7D
&sort=%7B%22createdAt%22%3A%22-1%22%7D
&option=%7B%22offset%22%3A0%2C%22per_page%22%3A2%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	-	チャンネル ID
`project_id`	String	-	プロジェクト ID
`name`	String	-	チャンネル名
`user_id`	String	-	チャンネル作成者 ID
`user`	Object	-	作成者情報
`user.id`	String	-	チャンネル作成者 ID
`user.name`	String	-	作成者名
`user.profile`	String	-	作成者のプロファイル画像
`unique_id`	String	-	チャンネル固有 ID 固有の識別目的でユーザーが入力する ID
`type`	String	-	チャンネルタイプ `PUBLIC` \| `PRIVATE` `PUBLIC`: 公開 `PRIVATE`: 非公開
`translation`	Boolean	-	自動翻訳するか `true` \| `false` `true`: 翻訳 `false`: 翻訳しない
`members`	Array	-	購読可能なユーザー IDリスト `type`が`PRIVATE`の場合、有効値を表示
`disabled`	Boolean	-	無効化かどうか `true` \| `false` `true`: 無効化 `false`: 有効化
`mutes`	Boolean	-	ミュートするか `true` \| `false` `true`: ミュート `false`: ミュートしない
`push`	Boolean	-	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`limit`	Integer	-	最大参加人数 `0`: 無制限
`link_url`	String	-	チャンネルリンク URL
`image_url`	Array	-	チャンネル画像 URL
`created_at`	String	-	チャンネルの作成日時 ISO 8601形式
`updated_at`	String	-	情報更新日時 ISO 8601形式

レスポンスステータスコード

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "id": "ef14cd79-****-****-****-3efc52465f08",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "channel_apitester",
        "user_id": "39c8de0f-****-****-****-6a1a875df59f",
        "user": {
            "id": "TWVtYmVyczo**********************************ODc1ZGY1OWY=",
            "name": "apitester",
            "profile": ""
        },
        "unique_id": "apitester123",
        "type": "PUBLIC",
        "translation": true,
        "members": [],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 0,
        "link_url": null,
        "image_url": null,
        "created_at": "2025-07-23T13:52:52+09:00",
        "updated_at": "2025-07-23T14:03:20+09:00"
    },
    {
        "id": "5169ed4b-****-****-****-2c89ec3dc97e",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "channel_name_test",
        "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
        "user": {
            "id": "TWVtYmVyczp************************************jZDRmZWY0NmU=",
            "name": "Admin",
            "profile": ""
        },
        "unique_id": null,
        "type": "PUBLIC",
        "translation": false,
        "members": [],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 0,
        "link_url": null,
        "image_url": null,
        "created_at": "2025-07-20T00:36:55+09:00",
        "updated_at": "2025-07-20T00:36:55+09:00"
    }
]