Channel ペアリングの取得

Channel ペアリングは現在 Beta 機能です。API 定義、レスポンス構造、動作は変更される可能性があります。ドキュメントの更新をご確認ください。

GET /api/v1/forward/channel_pairings/{pairing_id} 未バインドまたはバインド済みのペアリングレコードを 1 件取得します。

リクエストパラメータ

Authorization: Bearer <PAT または SAT> を使用します。必須のパスパラメータ pairing_id は、ペアリングの一覧で返される id です。

リクエスト例

curl -s 'https://api.qoder.com/api/v1/forward/channel_pairings/pair_019eabc123' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

レスポンス例

HTTP 200 OK

{
  "id": "pair_019eabc123",
  "type": "channel_pairing",
  "channel_id": "channel_019eabc123",
  "scope_type": "direct",
  "scope_external_id": "external_user_id",
  "scope_display_name": "テストユーザー",
  "status": "active",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_workspace_dev",
  "paired_at": "2026-09-09T08:00:00Z",
  "created_at": "2026-09-09T07:50:00Z",
  "updated_at": "2026-09-09T08:00:00Z"
}

scope_type は direct（個人チャット）または room（グループチャット）です。scope_external_id は、対応する外部ユーザー ID またはグループ ID です。未バインドの場合は status=pairing となり、identity_id、template_id、paired_at は空文字列です。ペアリングコードの有効期限が切れても、この状態は変わりません。API はペアリングコードを返しません。 scope_display_name はユーザーのニックネームまたはグループ名です。空の場合もあり、表示専用です。

HTTP エラーコード

HTTP	Type	発生条件
400	`invalid_request_error`	`pairing_id` が空白または制御文字を含む場合、または Channel が `pairing` モードではない場合。
401	`authentication_error`	PAT または SAT が無効または期限切れの場合。
403	`permission_error`	API の呼び出し権限がない場合。
404	`not_found_error`	ペアリングが存在しないか解除済み、または所属する Channel が存在しない、アーカイブ済み、もしくはアクセス不可の場合。

Channel ペアリングの取得

リクエストパラメータ

リクエスト例

レスポンス例

HTTP エラーコード

関連 API

ペアリングの一覧

Channel のペアリング

ペアリングの更新

​リクエストパラメータ

​リクエスト例

​レスポンス例

​HTTP エラーコード

​関連 API

ペアリングの一覧

Channel のペアリング

ペアリングの更新

リクエストパラメータ

リクエスト例

レスポンス例

HTTP エラーコード

関連 API