---
title: "获取 Channel"
method: GET
path: "/agent/forward/v0/channels/{channelId}"
tags: ["Channel"]
---

# 获取 Channel

`GET /agent/forward/v0/channels/{channelId}`

## Request

- Base URL: `https://agent-api.bigmodel.cn/api`
- URL: `https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}`
- Auth: HTTP bearer

读取指定 Channel 的固定 Agent 版本、配置、绑定状态、连接状态和最近连接错误。凭据、扫码 token、平台消息 ID、内部 Session ID 和计费字段不回显。

## Path parameters

- `channelId` string, required

## Headers

- `zai-version` '2026-05-26', required
- `zai-beta` string, required

## Response `200`

请求成功。

- union: 固定 Agent 版本和渠道安全配置。不回显 credentials、扫码 token、平台消息 ID、内部 Session ID 或计费字段。
  - ForwardFeishuChannel
    - `id` string, required
    - `type` 'channel', required
    - `channel_type` 'feishu', required: 渠道平台。
    - `name` string, required
    - `template` ForwardChannelTemplate, required
      - `agent` ForwardChannelAgent, required
        - `type` 'agent', required
        - `id` string, required
        - `version` integer, required
      - `environment_id` string, required: 当前账号未归档的 Environment ID；trim 后 1–128 字符。
      - `vault_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `file_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `memory_stores` ForwardChannelMemoryStore[], required: 共享 Memory Store；ID 不可重复，与自动创建的私有 Store 合计最多挂载 8 个。
        - `memory_store_id` string, required: Memory Store ID；trim 后 1–128 字符，须属于当前账号且未归档。
        - `access` 'read_only' | 'read_write'
    - `enabled` boolean, required: 新建 Channel 固定为 true。
    - `binding_status` string, required: 绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为 bound。其他渠道通常创建后为 bound。
    - `connection_status` 'disconnected' | 'connecting' | 'connected' | 'error', required: 异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看 last_error。
    - `channel_config` ForwardFeishuChannelConfig, required
      - `response_options` ForwardChannelResponseOptions, required
        - `include_tool_calls` boolean, required: 展示公开工具名称、状态和返回项数；不展示工具原始参数或结果。
        - `include_process` boolean, required: 展示公开 Agent 过程正文，不展示隐藏推理。最终回复取本轮最后一条非空 agent.message。
        - `card_output` boolean, required: 启用渠道卡片或流式展示；false 时仅发送最终文本。钉钉还需有效互动卡片模板；个人微信始终仅最终回复。
      - `private_memory_store_enabled` boolean, required
      - `group_prompt_template` string, nullable, required: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
      - `group_reply_in_thread` boolean, required: 仅 Feishu。true 时普通群 @ 后在触发消息下创建话题回复；false 直接回复。已有话题沿用原话题，私聊不受影响；不扩大历史权限。
    - `last_error` object, nullable, required: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
    - `created_at` string, date-time, required: 创建时间。
    - `updated_at` string, date-time, required: 更新时间。
  - ForwardWeComChannel
    - `id` string, required
    - `type` 'channel', required
    - `channel_type` 'wecom', required: 渠道平台。
    - `name` string, required
    - `template` ForwardChannelTemplate, required
      - `agent` ForwardChannelAgent, required
        - `type` 'agent', required
        - `id` string, required
        - `version` integer, required
      - `environment_id` string, required: 当前账号未归档的 Environment ID；trim 后 1–128 字符。
      - `vault_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `file_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `memory_stores` ForwardChannelMemoryStore[], required: 共享 Memory Store；ID 不可重复，与自动创建的私有 Store 合计最多挂载 8 个。
        - `memory_store_id` string, required: Memory Store ID；trim 后 1–128 字符，须属于当前账号且未归档。
        - `access` 'read_only' | 'read_write'
    - `enabled` boolean, required: 新建 Channel 固定为 true。
    - `binding_status` string, required: 绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为 bound。其他渠道通常创建后为 bound。
    - `connection_status` 'disconnected' | 'connecting' | 'connected' | 'error', required: 异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看 last_error。
    - `channel_config` ForwardWeComChannelConfig, required
      - `response_options` ForwardChannelResponseOptions, required
        - `include_tool_calls` boolean, required: 展示公开工具名称、状态和返回项数；不展示工具原始参数或结果。
        - `include_process` boolean, required: 展示公开 Agent 过程正文，不展示隐藏推理。最终回复取本轮最后一条非空 agent.message。
        - `card_output` boolean, required: 启用渠道卡片或流式展示；false 时仅发送最终文本。钉钉还需有效互动卡片模板；个人微信始终仅最终回复。
      - `private_memory_store_enabled` boolean, required
      - `group_prompt_template` string, nullable, required: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
    - `last_error` object, nullable, required: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
    - `created_at` string, date-time, required: 创建时间。
    - `updated_at` string, date-time, required: 更新时间。
  - ForwardDingTalkChannel
    - `id` string, required
    - `type` 'channel', required
    - `channel_type` 'dingtalk', required: 渠道平台。
    - `name` string, required
    - `template` ForwardChannelTemplate, required
      - `agent` ForwardChannelAgent, required
        - `type` 'agent', required
        - `id` string, required
        - `version` integer, required
      - `environment_id` string, required: 当前账号未归档的 Environment ID；trim 后 1–128 字符。
      - `vault_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `file_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `memory_stores` ForwardChannelMemoryStore[], required: 共享 Memory Store；ID 不可重复，与自动创建的私有 Store 合计最多挂载 8 个。
        - `memory_store_id` string, required: Memory Store ID；trim 后 1–128 字符，须属于当前账号且未归档。
        - `access` 'read_only' | 'read_write'
    - `enabled` boolean, required: 新建 Channel 固定为 true。
    - `binding_status` string, required: 绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为 bound。其他渠道通常创建后为 bound。
    - `connection_status` 'disconnected' | 'connecting' | 'connected' | 'error', required: 异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看 last_error。
    - `channel_config` ForwardDingTalkChannelConfig, required
      - `response_options` ForwardChannelResponseOptions, required
        - `include_tool_calls` boolean, required: 展示公开工具名称、状态和返回项数；不展示工具原始参数或结果。
        - `include_process` boolean, required: 展示公开 Agent 过程正文，不展示隐藏推理。最终回复取本轮最后一条非空 agent.message。
        - `card_output` boolean, required: 启用渠道卡片或流式展示；false 时仅发送最终文本。钉钉还需有效互动卡片模板；个人微信始终仅最终回复。
      - `private_memory_store_enabled` boolean, required
      - `group_prompt_template` string, nullable, required: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
      - `card_template_id` string, nullable, required: 仅 DingTalk；已发布且该应用可访问的互动卡片模板 ID。trim 后 1–256 字符，只含字母、数字、下划线、点、冒号、连字符；null 关闭模板。
      - `card_content_key` string, required: 仅 DingTalk；绑定 Markdown 正文的变量名，默认 content。trim 后 1–64 字符，字母开头，后续仅字母、数字或下划线。
    - `last_error` object, nullable, required: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
    - `created_at` string, date-time, required: 创建时间。
    - `updated_at` string, date-time, required: 更新时间。
  - ForwardWeChatChannel
    - `id` string, required
    - `type` 'channel', required
    - `channel_type` 'wechat', required: 渠道平台。
    - `name` string, required
    - `template` ForwardChannelTemplate, required
      - `agent` ForwardChannelAgent, required
        - `type` 'agent', required
        - `id` string, required
        - `version` integer, required
      - `environment_id` string, required: 当前账号未归档的 Environment ID；trim 后 1–128 字符。
      - `vault_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `file_ids` string[], required: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
      - `memory_stores` ForwardChannelMemoryStore[], required: 共享 Memory Store；ID 不可重复，与自动创建的私有 Store 合计最多挂载 8 个。
        - `memory_store_id` string, required: Memory Store ID；trim 后 1–128 字符，须属于当前账号且未归档。
        - `access` 'read_only' | 'read_write'
    - `enabled` boolean, required: 新建 Channel 固定为 true。
    - `binding_status` string, required: 绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为 bound。其他渠道通常创建后为 bound。
    - `connection_status` 'disconnected' | 'connecting' | 'connected' | 'error', required: 异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看 last_error。
    - `channel_config` ForwardWeChatChannelConfig, required
      - `response_options` ForwardChannelResponseOptions, required
        - `include_tool_calls` boolean, required: 展示公开工具名称、状态和返回项数；不展示工具原始参数或结果。
        - `include_process` boolean, required: 展示公开 Agent 过程正文，不展示隐藏推理。最终回复取本轮最后一条非空 agent.message。
        - `card_output` boolean, required: 启用渠道卡片或流式展示；false 时仅发送最终文本。钉钉还需有效互动卡片模板；个人微信始终仅最终回复。
      - `private_memory_store_enabled` boolean, required
      - `group_prompt_template` 'null', nullable, required: WeChat 固定为 null。
    - `last_error` object, nullable, required: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
    - `created_at` string, date-time, required: 创建时间。
    - `updated_at` string, date-time, required: 更新时间。

## Other responses

- `404`: 资源不存在、已删除或不属于当前账号。
- `429`: 账号或全局请求频率超限。

## Changes

- **2026-11-05** `f2be7c0fcbb9`: 14 breaking, 1 warning, 2 info
  - added `#/components/schemas/ForwardFeishuChannel, #/components/schemas/ForwardWeComChannel, #/components/schemas/ForwardDingTalkChannel, #/components/schemas/ForwardWeChatChannel` to the response body `oneOf` list for the response status `200`
  - the response's body type changed from `object` to no type for status `200`
  - removed the required property `binding_status` from the response with the `200` status
  - removed the required property `channel_config` from the response with the `200` status
  - …13 more
- **2026-11-03** `7fd61aa7f811`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigmodel/apis/zhipu-ai-api/changes/agent/forward/v0/channels/:channelId/get.md)

---

[API](https://skmtc.dev/bigmodel/apis/zhipu-ai-api.md) - [All operations](https://skmtc.dev/bigmodel/apis/zhipu-ai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bigmodel/apis/zhipu-ai-api/revisions/f2be7c0fcbb9?raw)