チャネルの作成

POST /api/v1/forward/channels 外部メッセージングプラットフォーム向けのチャネルインスタンスを作成します。チャネルは受信 IM メッセージを受け取り、設定されたプロバイダーを通じて返信を送信します。

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT または SAT>`
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	安全でないリクエスト向けの任意のべき等性キー。

Body parameters

Parameter	Type	Required	Description
`identity_id`	string	条件必須	`fixed` モードでは必須；`pairing` モードでは不要。
`identity_resolution.mode`	string	いいえ	Identity 解決モード：`fixed`（デフォルト）または `pairing`。
`template_id`	string	条件必須	`fixed` モードでは必須；`pairing` モードでは不要。
`channel_type`	string	Yes	チャネルタイプ。`wechat`、`wecom`、`feishu`、`dingtalk` をサポートし、Global では `teams` も利用できます。
`name`	string	No	チャネルの表示名。
`channel_config.credentials`	object	Conditional	チャネルの実行時認証情報。QR 認可チャネルでは省略できます。直接認証情報を使うチャネルはプロバイダー固有のフィールドを使用します。`feishu` は `app_id`/`app_secret`、`dingtalk` は `client_id`/`client_secret`、`wecom` は `bot_id`/`secret`、`teams` は `app_id`/`tenant_id`/`client_secret` を使用します。認証情報は平文では返されません。
`channel_config.response_options`	object	No	返信の表示設定。

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/channels' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identity_id": "idn_019eabc123",
    "identity_resolution": {
      "mode": "fixed"
    },
    "template_id": "tmpl_support",
    "channel_type": "feishu",
    "name": "Support Feishu channel",
    "channel_config": {
      "credentials": {
        "app_id": "...",
        "app_secret": "..."
      },
      "response_options": {
        "include_tool_calls": false,
        "include_thinking": false
      }
    }
  }'

pairing モードではトランスポート接続のみを作成し、Identity や Template は指定しません：

{
  "identity_resolution": {
    "mode": "pairing"
  },
  "channel_type": "feishu",
  "name": "Support Feishu channel"
}

Example response

HTTP 201 Created

{
  "id": "channel_019eabc123",
  "type": "channel",
  "identity_id": "idn_019eabc123",
  "identity_resolution": {
    "mode": "fixed"
  },
  "template_id": "tmpl_support",
  "channel_type": "feishu",
  "name": "Support Feishu channel",
  "enabled": true,
  "binding_status": "bound",
  "channel_config": {
    "response_options": {
      "include_tool_calls": false,
      "include_thinking": false
    }
  },
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

Response fields

Field	Type	Description
`id`	string	チャネル ID。プレフィックスの例は `channel_` です。
`type`	string	常に `channel`。
`identity_id`	string\|null	`fixed` モードではバインドされた Forward Identity ID；`pairing` モードでは `null`。
`identity_resolution.mode`	string	Identity 解決モード：`fixed` または `pairing`。
`template_id`	string\|null	`fixed` モードではバインドされた Forward Template ID；`pairing` モードでは `null`。
`channel_type`	string	外部チャネルタイプ。
`enabled`	boolean	手動での有効化・無効化スイッチ。
`binding_status`	string	`unbound`、`bound`、または `expired`。
`channel_config.response_options`	object	返信の表示設定。

Error codes

HTTP	Type	Trigger
400	`invalid_request_error`	チャネルタイプがサポートされていません。
400	`invalid_request_error`	必要な認証情報が不足しています。
400	`invalid_request_error`	Identity 解決モードと identity_id/template_id の組み合わせが一致しません。
401	`authentication_error`	PAT または SAT が無効または期限切れです。
403	`permission_error`	チャネル数がクォータの上限を超えています。
404	`not_found_error`	Template が存在しないか、参照できません。
404	`not_found_error`	Identity が存在しないか、参照できません。
409	`conflict_error`	Identity が無効になっています。
409	`conflict_error`	認証情報の検証に失敗しました（競合）。
502	`api_error`	チャネルサービスが利用できません。

Notes

新規チャネルはデフォルトで enabled=true になります。
チャネルが受信メッセージを処理できるのは、enabled=true かつ binding_status="bound" の場合のみです。
受信処理を一時的に停止するには、Update Channel で enabled=false を指定することをおすすめします。
fixed モードでは作成時に指定した Identity と Template を常に使用します。
pairing モードでは Channel はトランスポート接続のみを表し、Identity と Template は Pairing API によってメッセージスコープごとにバインドされます。
Identity 解決モードは作成後に変更できません。

チャネルの作成

Headers

Body parameters

Example request

Example response

Response fields

Error codes

Notes

チャネル QR セッションの作成

チャネルの一覧取得

​Headers

​Body parameters

​Example request

​Example response

​Response fields

​Error codes

​Notes

​Related

チャネル QR セッションの作成

チャネルの一覧取得

Headers

Body parameters

Example request

Example response

Response fields

Error codes

Notes

Related