チャンネルの照会

Prev Next

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

チャンネルの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /v1/api/channels/{channelId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID

リクエスト例

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

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/ef14cd79-****-****-****-3efc52465f08' \
--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": "TWVtYmVycz****************************************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"
}