Listing IM Channel Configurations

Lists IM channels configured for an agent instance based on the primary key ID of the agent instance.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:imChannel:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:imChannel:list	List	-	-	-	-

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Primary key ID of the agent instance.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
im_channels	Array of ImChannelItem objects	IM channel configuration list.

**Table 3** ImChannelItem
Parameter	Type	Description
platform	String	IM platform type. The value can be wecom, feishu, or dingtalk-connector.
enabled	Boolean	Whether the status is enabled.
client_id	String	Client ID.
platform_specific	Map<String,String>	Extended platform configuration.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

None

None

Parent topic: IM Channel Configuration Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.