アイデンティティとテンプレートに紐付けられた外部 IM チャネルを作成します。
リクエストヘッダー
|
ヘッダー |
必須 |
説明 |
|
|
はい |
|
|
|
はい |
|
|
|
いいえ |
安全でないリクエスト用のオプションのべき等キーです。 |
リクエストボディ
|
パラメータ |
タイプ |
必須 |
説明 |
|
|
string |
はい |
転送アイデンティティの ID です。呼び出し元に属しており、有効化されている必要があります。 |
|
|
string |
はい |
チャネルがセッションを作成する際に使用する転送テンプレートの ID です。 |
|
|
string |
はい |
チャネルタイプ。サポートされている値は |
|
|
string |
いいえ |
チャネルの表示名です。 |
|
|
object |
条件付き |
トークンまたはアプリ認証情報を使用するチャネルには必須です。QR 認可チャネルの場合は省略し、後で有効化することも可能です。 |
|
|
object |
いいえ |
レスポンスの可視性設定です。 |
リクエストの例
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/channels' \
-H "Authorization: Bearer $QODER_PAT" \
-H "Content-Type: application/json" \
-d '{
"identity_id": "idn_019eabc123",
"template_id": "tmpl_support",
"channel_type": "feishu",
"name": "Support Feishu channel",
"channel_config": {
"credentials": {
"app_key": "...",
"app_secret": "..."
},
"response_options": {
"include_tool_calls": false,
"include_thinking": false
}
}
}'
レスポンスの例
HTTP 201 Created
{
"id": "ci_019eabc123",
"type": "channel",
"identity_id": "idn_019eabc123",
"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"
}
レスポンスフィールド
|
フィールド |
タイプ |
説明 |
|
|
string |
チャネル ID。プレフィックスの例は |
|
|
string |
常に |
|
|
string |
紐付けられた転送アイデンティティの ID です。 |
|
|
string |
紐付けられた転送テンプレートの ID です。 |
|
|
string |
外部チャネルタイプです。 |
|
|
boolean |
手動で有効/無効を切り替えるスイッチです。 |
|
|
string |
|
|
|
object |
レスポンスの可視性設定です。 |
エラー
|
HTTP |
タイプ |
コード |
トリガー |
|
400 |
|
|
チャネルタイプがサポートされていません。 |
|
401 |
|
|
PAT が無効か、期限切れです。 |
|
404 |
|
|
テンプレートが存在しないか、アクセスできません。 |
|
404 |
|
|
アイデンティティが存在しないか、アクセスできません。 |
|
409 |
|
|
アイデンティティが無効化されています。 |
|
409 |
|
|
必要な認証情報または QR 認可が不足しています。 |
|
502 |
|
|
基盤となるチャネルの認可に失敗しました。 |
注意
-
user_idは、認証から内部的に導出され、決して公開されません。 -
新規チャネルは、デフォルトで
enabled=trueです。 -
チャネルがインバウンドメッセージを処理できるのは、
enabled=trueで、かつbinding_status="bound"の場合のみです。 -
チャネルの削除またはアーカイブはサポートされていません。代わりに
Update channelAPI を使用してチャネルを無効化してください。