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

查询 IM 通道配置列表 - ListImChannels

功能介绍

根据 Agent 实例主键 ID 查询其配置的 IM 通道列表。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:imChannel:list

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/{id}/im-channels

表1 路径参数

参数

是否必选

参数类型

描述

id

String

Agent 实例主键 ID

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

im_channels

Array of ImChannelItem objects

IM 通道配置列表

表3 ImChannelItem

参数

参数类型

描述

platform

String

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

enabled

Boolean

是否启用

client_id

String

客户端 ID

platform_specific

Map<String,String>

平台扩展配置

状态码: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

错误描述。

请求示例

响应示例

状态码

状态码

描述

200

操作成功。

400

请求参数错误。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误。

错误码

请参见错误码