> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 创建 Channel

> 创建绑定 Identity 和 Template 的外部 IM Channel。

`POST /api/v1/forward/channels`

创建外部消息平台的 Channel 实例，用于接收外部 IM 上行消息并发送回复。

## 请求头

| Header          | 是否必填 | 说明                 |
| --------------- | ---- | ------------------ |
| Authorization   | 是    | `Bearer <PAT>`     |
| Content-Type    | 是    | `application/json` |
| Idempotency-Key | 否    | 有副作用请求可选的幂等键。      |

## 请求体参数

| 参数                                | 类型      | 是否必填 | 说明                                                                                                                                                          |
| --------------------------------- | ------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| identity\_id                      | string  | 是    | Forward Identity ID，必须属于当前调用方且已启用。                                                                                                                          |
| template\_id                      | string  | 是    | 收到消息并创建 Session 时使用的 Forward Template ID。                                                                                                                   |
| channel\_type                     | string  | 是    | 渠道类型，当前支持 `wechat`、`wecom`、`feishu`、`dingtalk`。                                                                                                             |
| name                              | string  | 否    | Channel 展示名。                                                                                                                                                |
| enabled                           | boolean | 否    | 人工启停开关，默认 `true`。传 `false` 可创建后暂不处理上行消息。                                                                                                                    |
| channel\_config.credentials       | object  | 条件必填 | 渠道运行凭据。扫码授权类渠道可省略；直连凭据类渠道按 `channel_type` 传入：`feishu` 为 `app_id`/`app_secret`，`dingtalk` 为 `client_id`/`client_secret`，`wecom` 为 `bot_id`/`secret`。凭据不明文回显。 |
| channel\_config.response\_options | object  | 否    | 回复内容可见性配置。                                                                                                                                                  |

## 示例请求

```bash theme={null}
curl -s -X POST 'https://api.qoder.com/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",
  "enabled": true,
  "channel_config": {
    "credentials": {
      "app_id": "...",
      "app_secret": "..."
    },
    "response_options": {
      "include_tool_calls": false,
      "include_thinking": false
    }
  }
}'
```

## 示例响应

**HTTP 201 Created**

```json theme={null}
{
  "id": "channel_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"
}
```

## 响应字段

| 字段              | 类型      | 说明                             |
| --------------- | ------- | ------------------------------ |
| id              | string  | Channel ID，示例前缀 `channel_`。    |
| type            | string  | 固定为 `channel`。                 |
| identity\_id    | string  | 绑定的 Forward Identity ID。       |
| template\_id    | string  | 绑定的 Forward Template ID。       |
| channel\_type   | string  | 外部渠道类型。                        |
| enabled         | boolean | 人工启停开关。                        |
| binding\_status | string  | `unbound`、`bound` 或 `expired`。 |

## 错误

| HTTP | Type                    | Code                         | 触发条件              |
| ---- | ----------------------- | ---------------------------- | ----------------- |
| 400  | `invalid_request_error` | `channel_type_unsupported`   | 渠道类型不支持。          |
| 404  | `not_found_error`       | `channel_template_not_found` | Template 不存在或不可见。 |
| 404  | `not_found_error`       | `channel_identity_not_found` | Identity 不存在或不可见。 |
| 409  | `conflict_error`        | `channel_identity_disabled`  | Identity 已停用。     |
| 409  | `conflict_error`        | `channel_auth_required`      | 缺少必要凭据或需要先扫码授权。   |
| 502  | `api_error`             | `channel_auth_failed`        | 渠道授权失败。           |
| 401  | `authentication_error`  | `authentication_required`    | PAT 无效或已过期。       |

## 注意事项

* `enabled` 为可选入参，默认 `true`；传 `false` 可在绑定完成前暂不启用。
* 只有 `enabled=true` 且 `binding_status=bound` 时才可处理上行消息。
* 如果只是临时停止处理上行消息，优先使用 Update Channel 设置 `enabled=false`。

## 相关

<CardGroup cols={2}>
  <Card title="创建 Channel QR Session" icon="qrcode" href="/cloud-agents/api/forward/channels/create-qr-session" />

  <Card title="列出 Channels" icon="list" href="/cloud-agents/api/forward/channels/list" />
</CardGroup>