Channel のペアリング

POST /api/v1/forward/channel_pairings identity_resolution.mode=pairing の Channel にのみ適用されます。

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT または SAT>`
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	安全なリトライのためのクライアント生成のべき等性キー。

Body parameters

Parameter	Type	Required	Description
`code`	string	いずれか一方	Channel メッセージに表示された有効なペアリングコード。`code` と `channel_pairing_id` のどちらか一方のみを指定します。
`channel_pairing_id`	string	いずれか一方	ペアリングの一覧で返される `id`。ID による認可はペアリングコードの有効期限に影響されません。
`identity_id`	string	Yes	バインドする Forward Identity ID。
`template_id`	string	Yes	バインドする Forward Template ID。

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/channel_pairings' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pairing-K7MP92" \
  -d '{
    "code": "K7MP92",
    "identity_id": "idn_019eabc123",
    "template_id": "tmpl_workspace_dev"
  }'

同じエンドポイントと認証を使用して、ID でもペアリングを完了できます:

{
  "channel_pairing_id": "pair_019eabc123",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_workspace_dev"
}

Example response

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": "テストユーザー",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_workspace_dev",
  "status": "active",
  "paired_at": "2026-07-16T10:00:00Z"
}

Response fields

Field	Type	Description
`id`	string	Pairing ID。一覧、詳細取得、ペアリング解除に使用します。Schedule の Sink は `channel_pairing_id` でこの値を参照します。
`type`	string	常に `channel_pairing`。
`channel_id`	string	Channel ID。
`scope_type`	string	ペアリングスコープ。`direct` は個人チャットのユーザー、`room` はグループチャット。
`scope_external_id`	string	スコープに対応する外部ユーザー ID またはグループ ID。
`scope_display_name`	string	ユーザーのニックネームまたはグループ名。取得できない場合は空文字列です。表示専用で、認可の判断には使用しません。
`identity_id`	string	バインドされた Forward Identity ID。
`template_id`	string	バインドされた Forward Template ID。
`status`	string	ペアリング成功時は `active`。
`paired_at`	string	ペアリング完了時刻。

HTTP エラーコード

HTTP	Type	発生条件
400	`invalid_request_error`	パラメータの不足、形式の不正、未知のフィールド、無効なペアリングコード（使用済みを含む）や期限切れ、または Channel が `pairing` モードではない場合。
401	`authentication_error`	PAT または SAT が無効または期限切れの場合。
403	`permission_error`	API の呼び出し権限がない場合。
404	`not_found_error`	Pair、Channel、Identity、Template が存在しないかアクセス不可、または Channel がアーカイブ済みの場合。
409	`conflict_error`	バインド先の競合、Pair が解除済み、Identity が無効化済み、または同時アクティブ化の競合。ID でペアリングする場合は、Channel が有効化されていないか、バインドされていない場合も該当します。

Notes

再試行には channel_pairing_id を使用してください。リソースが利用可能で Pair が解除されていなければ、同じバインディングはべき等に成功します。使用済みまたは期限切れのコードで再ペアリングすることはできません。
バインディングの変更にはペアリングの更新を使用してください。
ペアリング成功前に送信したメッセージは自動的には再送されません。再度送信してください。

Channel のペアリング

Headers

Body parameters

Example request

Example response

Response fields

HTTP エラーコード

Notes

関連 API

Channel の作成

Channel のペアリング解除

ペアリングの一覧

ペアリングの取得

ペアリングの更新

​Headers

​Body parameters

​Example request

​Example response

​Response fields

​HTTP エラーコード

​Notes

​関連 API

Channel の作成

Channel のペアリング解除

ペアリングの一覧

ペアリングの取得

ペアリングの更新

Headers

Body parameters

Example request

Example response

Response fields

HTTP エラーコード

Notes

関連 API