
# 查询 IM 通道配置列表 - ListImChannels
#### 功能介绍
根据 Agent 实例主键 ID 查询其配置的 IM 通道列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListImChannels)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | 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 通道配置列表 |
   
 表3ImChannelItem 
| 参数                | 参数类型                 | 描述                                          |
|:---|:---|:---|
| 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 | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。   - 原因：说明导致错误的根本原因。   - 方案：给出修复建议或后续操作指引。    |
   
#### 请求示例
```
GET /v3/ai-agents/1234567890/im-channels
```
#### 响应示例
**状态码：200**
操作成功。
```
{
  "im_channels" : [ {
    "platform" : "feishu",
    "enabled" : true,
    "client_id" : "cli_xxxxx",
    "platform_specific" : {
      "app_id" : "app_123"
    }
  }, {
    "platform" : "dingtalk-connector",
    "enabled" : false,
    "client_id" : "ding_xxxxx",
    "platform_specific" : { }
  } ]
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 操作成功。   |
| 400 | 请求参数错误。 |
| 401 | 鉴权失败。   |
| 403 | 没有操作权限。 |
| 500 | 服务内部错误。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
