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

# 列出 Channel

> 分页列出当前账号的四类公开 Channel，data[] 可以混合返回 Feishu、WeCom、DingTalk、WeChat。不提供渠道平台、Agent 或状态过滤。

| 参数 | 默认值 | 规则 |
| - | - | - |
| `limit` | `20` | 整数，1–100 |
| `order` | `desc` | 只允许 `asc` / `desc` |
| `page` | 无 | 上次返回的 opaque cursor（不透明游标），不得解析或自拼 |

`next_page` 仅表示当前排序方向的下一页；为 null 表示没有下一页。翻页保持原排序方向。

## 安全响应

所有元素返回固定版本的 `template`、绑定/连接状态、`last_error` 及安全 `channel_config`，不回显 credentials、扫码 token、平台消息 ID、内部 Session ID 或计费字段。

| 渠道 | channel\_config 返回字段 |
| - | - |
| 所有渠道 | `response_options`、`private_memory_store_enabled`、`group_prompt_template`（微信固定 null） |
| Feishu | 另返回 `group_reply_in_thread`，默认 false |
| DingTalk | 另返回 `card_template_id`（默认 null）、`card_content_key`（默认 content） |
| WeCom / WeChat | 不返回飞书或钉钉专属字段 |

## 请求示例

```bash
curl --request GET "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels" \
  --header "Authorization: Bearer $ZHIPUAI_API_KEY" \
  --header "zai-version: 2026-05-26" \
  --header "zai-beta: managed-agents-2026-05-26" --get --data-urlencode "limit=20" --data-urlencode "order=desc"
```

状态含义见[获取 Channel](https://docs.bigmodel.cn/api-reference/channel/get.md)，限流规则见[创建 Channel](https://docs.bigmodel.cn/api-reference/channel/create.md)。


## OpenAPI

````yaml /openapi/openapi-channel.json get /agent/forward/v0/channels
openapi: 3.0.1
info:
  title: Channel API
  version: '2026-10-30'
  description: >-
    Channel API v0：将固定版本的 Agent
    接入飞书、企业微信、钉钉和个人微信。提供创建、分页查询、详情、有限配置更新、删除以及微信扫码会话创建和查询。连接异步建立；201 仅表示配置保存成功。
servers:
  - url: https://agent-api.bigmodel.cn/api
    description: 生产环境
security:
  - bearerAuth: []
tags:
  - name: Channel
    description: 渠道管理；Agent 运行仍通过 Managed Session 和 Events API。
paths:
  /agent/forward/v0/channels:
    get:
      tags:
        - Channel
      summary: 列出 Channel
      description: >-
        分页列出当前账号的四类公开 Channel，data[] 可以混合返回
        Feishu、WeCom、DingTalk、WeChat。不提供渠道平台、Agent 或状态过滤。
      operationId: forwardGetChannels
      parameters:
        - $ref: '#/components/parameters/ForwardZaiVersion'
        - $ref: '#/components/parameters/ForwardZaiBeta'
        - name: limit
          in: query
          required: false
          description: 每页数量。
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: order
          in: query
          required: false
          description: 排序方向。
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: page
          in: query
          required: false
          description: 上一页返回的不透明游标；不能解析或自行拼接。next_page 只表示当前排序方向的下一页。
          schema:
            type: string
      responses:
        '200':
          description: 请求成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardChannelPage'
              example:
                data:
                  - id: channel_feishu_xxx
                    type: channel
                    channel_type: feishu
                    name: 飞书 Channel xxx
                    template:
                      agent:
                        type: agent
                        id: agent_xxx
                        version: 3
                      environment_id: env_xxx
                      vault_ids: []
                      file_ids: []
                      memory_stores: []
                    enabled: true
                    binding_status: bound
                    connection_status: disconnected
                    channel_config:
                      response_options:
                        include_tool_calls: false
                        include_process: false
                        card_output: true
                      private_memory_store_enabled: false
                      group_prompt_template: null
                      group_reply_in_thread: true
                    last_error: null
                    created_at: '2026-10-30T00:00:00.000Z'
                    updated_at: '2026-10-30T00:00:00.000Z'
                  - id: channel_wecom_xxx
                    type: channel
                    channel_type: wecom
                    name: 企业微信 Channel xxx
                    template:
                      agent:
                        type: agent
                        id: agent_xxx
                        version: 3
                      environment_id: env_xxx
                      vault_ids: []
                      file_ids: []
                      memory_stores: []
                    enabled: true
                    binding_status: bound
                    connection_status: disconnected
                    channel_config:
                      response_options:
                        include_tool_calls: false
                        include_process: false
                        card_output: true
                      private_memory_store_enabled: false
                      group_prompt_template: null
                    last_error: null
                    created_at: '2026-10-30T00:00:00.000Z'
                    updated_at: '2026-10-30T00:00:00.000Z'
                  - id: channel_dingtalk_xxx
                    type: channel
                    channel_type: dingtalk
                    name: 钉钉 Channel xxx
                    template:
                      agent:
                        type: agent
                        id: agent_xxx
                        version: 3
                      environment_id: env_xxx
                      vault_ids: []
                      file_ids: []
                      memory_stores: []
                    enabled: true
                    binding_status: bound
                    connection_status: disconnected
                    channel_config:
                      response_options:
                        include_tool_calls: false
                        include_process: false
                        card_output: true
                      private_memory_store_enabled: false
                      group_prompt_template: null
                      card_template_id: xxx.schema
                      card_content_key: content
                    last_error: null
                    created_at: '2026-10-30T00:00:00.000Z'
                    updated_at: '2026-10-30T00:00:00.000Z'
                  - id: channel_wechat_xxx
                    type: channel
                    channel_type: wechat
                    name: 个人微信 Channel xxx
                    template:
                      agent:
                        type: agent
                        id: agent_xxx
                        version: 3
                      environment_id: env_xxx
                      vault_ids: []
                      file_ids: []
                      memory_stores: []
                    enabled: true
                    binding_status: unbound
                    connection_status: disconnected
                    channel_config:
                      response_options:
                        include_tool_calls: false
                        include_process: false
                        card_output: true
                      private_memory_store_enabled: false
                      group_prompt_template: null
                    last_error: null
                    created_at: '2026-10-30T00:00:00.000Z'
                    updated_at: '2026-10-30T00:00:00.000Z'
                next_page: null
        '400':
          description: 请求字段或类型不合法。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardAgentErrorResponse'
              example:
                type: error
                error:
                  type: invalid_request_error
                  message: 请求字段或类型不合法。
                  details: {}
                request_id: req_xxx
        '429':
          description: 账号或全局请求频率超限。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardAgentErrorResponse'
              example:
                type: error
                error:
                  type: rate_limit_error
                  message: 账号或全局请求频率超限。
                  details: {}
                request_id: req_xxx
          headers:
            retry-after:
              description: 建议等待的相对秒数。503 并发预检忙时可为 1。
              schema:
                type: string
            ratelimit-limit:
              description: 当前桶容量。
              schema:
                type: string
            ratelimit-remaining:
              description: 剩余容量，拒绝时为 0。
              schema:
                type: string
            ratelimit-reset:
              description: 恢复一个请求额度所需的相对秒数。
              schema:
                type: string
            x-ratelimit-scope:
              description: 仅全局限流时返回 global。
              schema:
                type: string
components:
  parameters:
    ForwardZaiVersion:
      name: zai-version
      in: header
      required: true
      description: Channel API v0 基础协议标识，固定为 2026-05-26。
      schema:
        type: string
        enum:
          - '2026-05-26'
        default: '2026-05-26'
        example: '2026-05-26'
    ForwardZaiBeta:
      name: zai-beta
      in: header
      required: true
      description: 可有多个逗号分隔值，但必须包含 managed-agents-2026-05-26。
      schema:
        type: string
        default: managed-agents-2026-05-26
        example: managed-agents-2026-05-26
  schemas:
    ForwardChannelPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ForwardChannel'
        next_page:
          type: string
          nullable: true
          description: 当前排序方向的下一页不透明游标；没有下一页为 null。不得解析或自行拼接。
      required:
        - data
        - next_page
      additionalProperties: false
      example:
        data:
          - id: channel_feishu_xxx
            type: channel
            channel_type: feishu
            name: 飞书 Channel xxx
            template:
              agent:
                type: agent
                id: agent_xxx
                version: 3
              environment_id: env_xxx
              vault_ids: []
              file_ids: []
              memory_stores: []
            enabled: true
            binding_status: bound
            connection_status: disconnected
            channel_config:
              response_options:
                include_tool_calls: false
                include_process: false
                card_output: true
              private_memory_store_enabled: false
              group_prompt_template: null
              group_reply_in_thread: true
            last_error: null
            created_at: '2026-10-30T00:00:00.000Z'
            updated_at: '2026-10-30T00:00:00.000Z'
          - id: channel_wecom_xxx
            type: channel
            channel_type: wecom
            name: 企业微信 Channel xxx
            template:
              agent:
                type: agent
                id: agent_xxx
                version: 3
              environment_id: env_xxx
              vault_ids: []
              file_ids: []
              memory_stores: []
            enabled: true
            binding_status: bound
            connection_status: disconnected
            channel_config:
              response_options:
                include_tool_calls: false
                include_process: false
                card_output: true
              private_memory_store_enabled: false
              group_prompt_template: null
            last_error: null
            created_at: '2026-10-30T00:00:00.000Z'
            updated_at: '2026-10-30T00:00:00.000Z'
          - id: channel_dingtalk_xxx
            type: channel
            channel_type: dingtalk
            name: 钉钉 Channel xxx
            template:
              agent:
                type: agent
                id: agent_xxx
                version: 3
              environment_id: env_xxx
              vault_ids: []
              file_ids: []
              memory_stores: []
            enabled: true
            binding_status: bound
            connection_status: disconnected
            channel_config:
              response_options:
                include_tool_calls: false
                include_process: false
                card_output: true
              private_memory_store_enabled: false
              group_prompt_template: null
              card_template_id: xxx.schema
              card_content_key: content
            last_error: null
            created_at: '2026-10-30T00:00:00.000Z'
            updated_at: '2026-10-30T00:00:00.000Z'
          - id: channel_wechat_xxx
            type: channel
            channel_type: wechat
            name: 个人微信 Channel xxx
            template:
              agent:
                type: agent
                id: agent_xxx
                version: 3
              environment_id: env_xxx
              vault_ids: []
              file_ids: []
              memory_stores: []
            enabled: true
            binding_status: unbound
            connection_status: disconnected
            channel_config:
              response_options:
                include_tool_calls: false
                include_process: false
                card_output: true
              private_memory_store_enabled: false
              group_prompt_template: null
            last_error: null
            created_at: '2026-10-30T00:00:00.000Z'
            updated_at: '2026-10-30T00:00:00.000Z'
        next_page: null
    ForwardAgentErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - error
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - permission_error
                - invalid_request_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - api_error
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - type
            - message
            - details
          additionalProperties: false
        request_id:
          type: string
          example: req_xxx
      required:
        - type
        - error
        - request_id
      additionalProperties: false
    ForwardChannel:
      oneOf:
        - $ref: '#/components/schemas/ForwardFeishuChannel'
        - $ref: '#/components/schemas/ForwardWeComChannel'
        - $ref: '#/components/schemas/ForwardDingTalkChannel'
        - $ref: '#/components/schemas/ForwardWeChatChannel'
      discriminator:
        propertyName: channel_type
        mapping:
          feishu: '#/components/schemas/ForwardFeishuChannel'
          wecom: '#/components/schemas/ForwardWeComChannel'
          dingtalk: '#/components/schemas/ForwardDingTalkChannel'
          wechat: '#/components/schemas/ForwardWeChatChannel'
      description: 固定 Agent 版本和渠道安全配置。不回显 credentials、扫码 token、平台消息 ID、内部 Session ID 或计费字段。
    ForwardFeishuChannel:
      type: object
      properties:
        id:
          type: string
          example: channel_xxx
        type:
          type: string
          enum:
            - channel
        channel_type:
          type: string
          description: 渠道平台。
          enum:
            - feishu
        name:
          type: string
          example: Channel xxx
        template:
          $ref: '#/components/schemas/ForwardChannelTemplate'
        enabled:
          type: boolean
          description: 新建 Channel 固定为 true。
          example: true
        binding_status:
          type: string
          description: >-
            绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为
            bound。其他渠道通常创建后为 bound。
          example: bound
        connection_status:
          type: string
          description: >-
            异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看
            last_error。
          enum:
            - disconnected
            - connecting
            - connected
            - error
          example: disconnected
        channel_config:
          $ref: '#/components/schemas/ForwardFeishuChannelConfig'
        last_error:
          type: object
          nullable: true
          additionalProperties: true
          example: null
          description: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
        created_at:
          type: string
          format: date-time
          description: 创建时间。
        updated_at:
          type: string
          format: date-time
          description: 更新时间。
      required:
        - id
        - type
        - channel_type
        - name
        - template
        - enabled
        - binding_status
        - connection_status
        - channel_config
        - last_error
        - created_at
        - updated_at
      additionalProperties: false
      example:
        id: channel_feishu_xxx
        type: channel
        channel_type: feishu
        name: 飞书 Channel xxx
        template:
          agent:
            type: agent
            id: agent_xxx
            version: 3
          environment_id: env_xxx
          vault_ids: []
          file_ids: []
          memory_stores: []
        enabled: true
        binding_status: bound
        connection_status: disconnected
        channel_config:
          response_options:
            include_tool_calls: false
            include_process: false
            card_output: true
          private_memory_store_enabled: false
          group_prompt_template: null
          group_reply_in_thread: true
        last_error: null
        created_at: '2026-10-30T00:00:00.000Z'
        updated_at: '2026-10-30T00:00:00.000Z'
      title: 飞书
    ForwardWeComChannel:
      type: object
      properties:
        id:
          type: string
          example: channel_xxx
        type:
          type: string
          enum:
            - channel
        channel_type:
          type: string
          description: 渠道平台。
          enum:
            - wecom
        name:
          type: string
          example: Channel xxx
        template:
          $ref: '#/components/schemas/ForwardChannelTemplate'
        enabled:
          type: boolean
          description: 新建 Channel 固定为 true。
          example: true
        binding_status:
          type: string
          description: >-
            绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为
            bound。其他渠道通常创建后为 bound。
          example: bound
        connection_status:
          type: string
          description: >-
            异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看
            last_error。
          enum:
            - disconnected
            - connecting
            - connected
            - error
          example: disconnected
        channel_config:
          $ref: '#/components/schemas/ForwardWeComChannelConfig'
        last_error:
          type: object
          nullable: true
          additionalProperties: true
          example: null
          description: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
        created_at:
          type: string
          format: date-time
          description: 创建时间。
        updated_at:
          type: string
          format: date-time
          description: 更新时间。
      required:
        - id
        - type
        - channel_type
        - name
        - template
        - enabled
        - binding_status
        - connection_status
        - channel_config
        - last_error
        - created_at
        - updated_at
      additionalProperties: false
      example:
        id: channel_wecom_xxx
        type: channel
        channel_type: wecom
        name: 企业微信 Channel xxx
        template:
          agent:
            type: agent
            id: agent_xxx
            version: 3
          environment_id: env_xxx
          vault_ids: []
          file_ids: []
          memory_stores: []
        enabled: true
        binding_status: bound
        connection_status: disconnected
        channel_config:
          response_options:
            include_tool_calls: false
            include_process: false
            card_output: true
          private_memory_store_enabled: false
          group_prompt_template: null
        last_error: null
        created_at: '2026-10-30T00:00:00.000Z'
        updated_at: '2026-10-30T00:00:00.000Z'
      title: 企业微信
    ForwardDingTalkChannel:
      type: object
      properties:
        id:
          type: string
          example: channel_xxx
        type:
          type: string
          enum:
            - channel
        channel_type:
          type: string
          description: 渠道平台。
          enum:
            - dingtalk
        name:
          type: string
          example: Channel xxx
        template:
          $ref: '#/components/schemas/ForwardChannelTemplate'
        enabled:
          type: boolean
          description: 新建 Channel 固定为 true。
          example: true
        binding_status:
          type: string
          description: >-
            绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为
            bound。其他渠道通常创建后为 bound。
          example: bound
        connection_status:
          type: string
          description: >-
            异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看
            last_error。
          enum:
            - disconnected
            - connecting
            - connected
            - error
          example: disconnected
        channel_config:
          $ref: '#/components/schemas/ForwardDingTalkChannelConfig'
        last_error:
          type: object
          nullable: true
          additionalProperties: true
          example: null
          description: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
        created_at:
          type: string
          format: date-time
          description: 创建时间。
        updated_at:
          type: string
          format: date-time
          description: 更新时间。
      required:
        - id
        - type
        - channel_type
        - name
        - template
        - enabled
        - binding_status
        - connection_status
        - channel_config
        - last_error
        - created_at
        - updated_at
      additionalProperties: false
      example:
        id: channel_dingtalk_xxx
        type: channel
        channel_type: dingtalk
        name: 钉钉 Channel xxx
        template:
          agent:
            type: agent
            id: agent_xxx
            version: 3
          environment_id: env_xxx
          vault_ids: []
          file_ids: []
          memory_stores: []
        enabled: true
        binding_status: bound
        connection_status: disconnected
        channel_config:
          response_options:
            include_tool_calls: false
            include_process: false
            card_output: true
          private_memory_store_enabled: false
          group_prompt_template: null
          card_template_id: xxx.schema
          card_content_key: content
        last_error: null
        created_at: '2026-10-30T00:00:00.000Z'
        updated_at: '2026-10-30T00:00:00.000Z'
      title: 钉钉
    ForwardWeChatChannel:
      type: object
      properties:
        id:
          type: string
          example: channel_xxx
        type:
          type: string
          enum:
            - channel
        channel_type:
          type: string
          description: 渠道平台。
          enum:
            - wechat
        name:
          type: string
          example: Channel xxx
        template:
          $ref: '#/components/schemas/ForwardChannelTemplate'
        enabled:
          type: boolean
          description: 新建 Channel 固定为 true。
          example: true
        binding_status:
          type: string
          description: >-
            绑定状态。WeChat 创建后为 unbound；创建扫码会话后可能为 pending，继续查询 QR 状态；手机确认后为
            bound。其他渠道通常创建后为 bound。
          example: bound
        connection_status:
          type: string
          description: >-
            异步连接状态。disconnected 尚未建立；connecting 连接中；connected 已连接；error 查看
            last_error。
          enum:
            - disconnected
            - connecting
            - connected
            - error
          example: disconnected
        channel_config:
          $ref: '#/components/schemas/ForwardWeChatChannelConfig'
        last_error:
          type: object
          nullable: true
          additionalProperties: true
          example: null
          description: 最近连接错误的安全提示，正常时为 null；不能仅凭该字段判断某轮 Agent 执行是否成功。
        created_at:
          type: string
          format: date-time
          description: 创建时间。
        updated_at:
          type: string
          format: date-time
          description: 更新时间。
      required:
        - id
        - type
        - channel_type
        - name
        - template
        - enabled
        - binding_status
        - connection_status
        - channel_config
        - last_error
        - created_at
        - updated_at
      additionalProperties: false
      example:
        id: channel_wechat_xxx
        type: channel
        channel_type: wechat
        name: 个人微信 Channel xxx
        template:
          agent:
            type: agent
            id: agent_xxx
            version: 3
          environment_id: env_xxx
          vault_ids: []
          file_ids: []
          memory_stores: []
        enabled: true
        binding_status: unbound
        connection_status: disconnected
        channel_config:
          response_options:
            include_tool_calls: false
            include_process: false
            card_output: true
          private_memory_store_enabled: false
          group_prompt_template: null
        last_error: null
        created_at: '2026-10-30T00:00:00.000Z'
        updated_at: '2026-10-30T00:00:00.000Z'
      title: 个人微信
    ForwardChannelTemplate:
      type: object
      properties:
        agent:
          $ref: '#/components/schemas/ForwardChannelAgent'
        environment_id:
          type: string
          example: env_xxx
          description: 当前账号未归档的 Environment ID；trim 后 1–128 字符。
        vault_ids:
          type: array
          maxItems: 20
          items:
            type: string
            description: 资源 ID；trim 后 1–128 字符。
          example:
            - vault_xxx
          description: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
        file_ids:
          type: array
          maxItems: 20
          items:
            type: string
            description: 资源 ID；trim 后 1–128 字符。
          example:
            - file_xxx
          description: 默认 []，最多 20 项，服务端按 ID 去重；每个 ID trim 后为 1–128 字符，资源须属于当前账号。
        memory_stores:
          type: array
          items:
            $ref: '#/components/schemas/ForwardChannelMemoryStore'
          maxItems: 8
          description: 共享 Memory Store；ID 不可重复，与自动创建的私有 Store 合计最多挂载 8 个。
      required:
        - agent
        - environment_id
        - vault_ids
        - file_ids
        - memory_stores
      additionalProperties: false
    ForwardFeishuChannelConfig:
      type: object
      properties:
        response_options:
          $ref: '#/components/schemas/ForwardChannelResponseOptions'
        private_memory_store_enabled:
          type: boolean
        group_prompt_template:
          type: string
          description: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
          nullable: true
          maxLength: 4096
        group_reply_in_thread:
          type: boolean
          default: false
          description: >-
            仅 Feishu。true 时普通群 @ 后在触发消息下创建话题回复；false
            直接回复。已有话题沿用原话题，私聊不受影响；不扩大历史权限。
      required:
        - response_options
        - private_memory_store_enabled
        - group_prompt_template
        - group_reply_in_thread
      additionalProperties: false
      title: 飞书
    ForwardWeComChannelConfig:
      type: object
      properties:
        response_options:
          $ref: '#/components/schemas/ForwardChannelResponseOptions'
        private_memory_store_enabled:
          type: boolean
        group_prompt_template:
          type: string
          description: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
          nullable: true
          maxLength: 4096
      required:
        - response_options
        - private_memory_store_enabled
        - group_prompt_template
      additionalProperties: false
      title: 企业微信
    ForwardDingTalkChannelConfig:
      type: object
      properties:
        response_options:
          $ref: '#/components/schemas/ForwardChannelResponseOptions'
        private_memory_store_enabled:
          type: boolean
        group_prompt_template:
          type: string
          description: 群聊提示模板；所有渠道均返回。WeChat 固定为 null，不接受配置。
          nullable: true
          maxLength: 4096
        card_template_id:
          type: string
          description: >-
            仅 DingTalk；已发布且该应用可访问的互动卡片模板 ID。trim 后 1–256
            字符，只含字母、数字、下划线、点、冒号、连字符；null 关闭模板。
          nullable: true
          default: null
          pattern: ^\s*[A-Za-z0-9_.:-]{1,256}\s*$
        card_content_key:
          type: string
          description: >-
            仅 DingTalk；绑定 Markdown 正文的变量名，默认 content。trim 后 1–64
            字符，字母开头，后续仅字母、数字或下划线。
          default: content
          pattern: ^\s*[A-Za-z][A-Za-z0-9_]{0,63}\s*$
      required:
        - response_options
        - private_memory_store_enabled
        - group_prompt_template
        - card_template_id
        - card_content_key
      additionalProperties: false
      title: 钉钉
    ForwardWeChatChannelConfig:
      type: object
      properties:
        response_options:
          $ref: '#/components/schemas/ForwardChannelResponseOptions'
        private_memory_store_enabled:
          type: boolean
        group_prompt_template:
          type: string
          nullable: true
          enum:
            - null
          description: WeChat 固定为 null。
      required:
        - response_options
        - private_memory_store_enabled
        - group_prompt_template
      additionalProperties: false
      title: 个人微信
    ForwardChannelAgent:
      type: object
      properties:
        type:
          type: string
          enum:
            - agent
        id:
          type: string
          example: agent_xxx
        version:
          type: integer
          example: 3
      required:
        - type
        - id
        - version
      additionalProperties: false
    ForwardChannelMemoryStore:
      type: object
      properties:
        memory_store_id:
          type: string
          minLength: 1
          maxLength: 128
          example: memstore_xxx
          description: Memory Store ID；trim 后 1–128 字符，须属于当前账号且未归档。
        access:
          type: string
          enum:
            - read_only
            - read_write
          default: read_write
      additionalProperties: false
      required:
        - memory_store_id
    ForwardChannelResponseOptions:
      type: object
      properties:
        include_tool_calls:
          type: boolean
          default: false
          description: 展示公开工具名称、状态和返回项数；不展示工具原始参数或结果。
        include_process:
          type: boolean
          default: false
          description: 展示公开 Agent 过程正文，不展示隐藏推理。最终回复取本轮最后一条非空 agent.message。
        card_output:
          type: boolean
          default: true
          description: 启用渠道卡片或流式展示；false 时仅发送最终文本。钉钉还需有效互动卡片模板；个人微信始终仅最终回复。
      required:
        - include_tool_calls
        - include_process
        - card_output
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        标准的 HTTP Bearer 认证方式，在 [API
        Keys](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) 页面获取密钥。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.