Delivering the IM Channel Configuration

Function

Configures an IM channel (DingTalk/WeCom/Lark/WeWork).

Debugging

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

Authorization Information

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:create

Write

-

-

-

-

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

URI

POST /v3/ai-agents/im-channels

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Primary key ID of the agent instance.
im_channels	Yes	Array of ImChannelConfig objects	IM channel configuration list.

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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
config_ids	Array of strings	Configuration ID list.

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.

Example Requests

{
  "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" : { }
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
200	Operation successful.
400	The request cannot be understood by the server due to malformed syntax.
401	Authorization failed.
403	No permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: IM Channel Configuration Management

Previous topic: IM Channel Configuration Management

Next topic: Listing IM Channel Configurations

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot