文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ IM通道配置管理/ 下发 IM 通道配置 - SaveImChannels
更新时间:2026-07-24 GMT+08:00

下发 IM 通道配置 - SaveImChannels

功能介绍

配置 IM 通道(钉钉/企业微信/飞书/wework)。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:imChannel:create

    Write

    -

    -

    -

    -

URI

POST /v3/ai-agents/im-channels

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

id

String

Agent 实例主键 ID

im_channels

Array of ImChannelConfig objects

IM 通道配置列表

表2 ImChannelConfig

参数

是否必选

参数类型

描述

platform

String

IM 平台类型:wecom / feishu / dingtalk-connector

enabled

Boolean

是否启用

client_id

String

客户端 ID

client_secret

String

客户端密钥

platform_specific

Map<String,String>

平台扩展配置

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

config_ids

Array of strings

配置 ID 列表

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

{
  "id" : "1234567890",
  "im_channels" : [ {
    "platform" : "feishu",
    "enabled" : true,
    "client_id" : "cli_xxxxx",
    "client_secret" : "my_secret_key",
    "platform_specific" : {
      "app_id" : "app_123"
    }
  }, {
    "platform" : "dingtalk-connector",
    "enabled" : false,
    "client_id" : "ding_xxxxx",
    "client_secret" : "my_ding_secret",
    "platform_specific" : { }
  } ]
}

响应示例

状态码

状态码

描述

200

操作成功。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误。

错误码

请参见错误码