Channel ペアリングの一覧

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

GET /api/v1/forward/channel_pairings Authorization: Bearer <PAT または SAT> を使用します。呼び出し元がアクセスできる Channel ペアリングレコードのみを返します。デフォルトでは未バインドの pairing とバインド済みの active を含み、ペアリング解除済みの unbound は返しません。

クエリパラメータ

パラメータ	説明
`channel_id`	任意。アクセス可能な Channel を指定します。省略すると、アクセス可能なすべての Channel が対象です。
`status`	任意。`pairing` または `active`。ペアリングコードの有効期限が切れても、Pair は `pairing` のままです。
`target_type`	任意。`user`（個人チャット）または `group`（グループチャット）。
`target_external_id`	任意。外部ユーザー ID またはグループ ID と完全一致で検索します。Channel と対象タイプのフィルタとの併用を推奨します。
`identity_id` / `template_id`	任意。バインド済みレコードのみを絞り込み、Identity / Template の存在は検証しません。`status=pairing` と併用すると空の一覧を返します。
`limit`	1 ページあたりの件数。デフォルトは 20、1–100 の整数を指定します。
`after_id` / `before_id`	任意。返された Pairing の `id` をカーソルとして使用します。同時には指定できません。

例

GET /api/v1/forward/channel_pairings?channel_id=channel_019eabc123&status=pairing&target_type=group

{
  "data": [
    {
      "id": "pair_019eabc123",
      "type": "channel_pairing",
      "channel_id": "channel_019eabc123",
      "scope_type": "room",
      "scope_external_id": "external_group_id",
      "scope_display_name": "プロジェクト討論グループ",
      "status": "pairing",
      "identity_id": "",
      "template_id": "",
      "paired_at": "",
      "created_at": "2026-09-09T08:00:00Z",
      "updated_at": "2026-09-09T08:00:00Z"
    }
  ],
  "first_id": "pair_019eabc123",
  "last_id": "pair_019eabc123",
  "has_more": false
}

scope_type は direct（個人チャット）または room（グループチャット）です。scope_external_id は、対応する外部ユーザー ID またはグループ ID です。バインド済みのレコードは実際の identity_id、template_id、paired_at を返します。一覧にはペアリングコード、社員番号、社員の別名は含まれず、ペアリングコードの生成や更新も行いません。 identity_id / template_id に一致するバインディングがない場合、404 ではなく HTTP 200 OK と空の一覧を返します。

{"data":[],"first_id":null,"last_id":null,"has_more":false}

scope_display_name はユーザーのニックネームまたはグループ名です。空の場合もあり、表示専用です。

HTTP エラーコード

HTTP	Type	発生条件
400	`invalid_request_error`	フィルタ値が不正、`limit` が 1–100 の範囲外、両方のカーソルを指定、またはパラメータに制御文字が含まれる場合。
401	`authentication_error`	PAT または SAT が無効または期限切れの場合。
403	`permission_error`	API の呼び出し権限がない場合。
404	`not_found_error`	指定した `channel_id` が存在しないか、アクセスできない場合。

Channel ペアリングの一覧

クエリパラメータ

例

HTTP エラーコード

関連 API

ペアリングの取得

ペアリングの更新

​クエリパラメータ

​例

​HTTP エラーコード

​関連 API

ペアリングの取得

ペアリングの更新

クエリパラメータ

例

HTTP エラーコード

関連 API