Creates, updates, retrieves, and deletes chat configurations for platforms such as DingTalk.
Operation description
Description
Use this API to manage chatbot settings for integrations with instant messaging tools, such as DingTalk. You can create, update, retrieve, and delete chat configurations. You can implement fine-grained permission control for different users or user groups and specify a Resource Access Management (RAM) role to perform operations. You can also add tags to each configuration for easier management and categorization.
When you call this API, ensure that the RegionId, ConversationId, and all parameters in the request body are correct. Handle sensitive information, such as the ClientId and ClientSecret fields, with care to prevent unauthorized access.
Try it now
Test
RAM authorization
Request parameters
Parameter | Type | Required | Description | Example |
RegionId | string | No | The region ID. | cn-hangzhou |
| Filters | array<object> | No | A list of conditions to filter chat configurations. | [{"Name": "status", "Value": "inactive"}, {"Name": "type", "Value": "private"}] |
object | No | A filter condition that includes a name and a value. | {"Name": "status", "Value": "inactive"} | |
Name | string | No | The name of the filter condition. | status |
Value | string | No | The value of the filter condition. | inactive |
MaxResults | integer | No | The number of entries to return on each page for a paged query. | 10 |
NextToken | string | No | The token to retrieve the next page of results. Set this parameter to the `NextToken` value from the previous response. | AQEBARoBBgEAAgIBBQ== |
Response elements
Element | Type | Description | Example |
object | The details of a successful response. | ||
RequestId | string | The request ID. | 4DB0****1234 |
| ChatConfigurations | array<object> | A list of chat configurations. | [{"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}]} |
object | The details of a chat configuration. | {"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}"} | |
Name | string | The name of the chat configuration. | test-wechat |
CreatedDate | string | The time when the chat configuration was created. | 2025-12-10T10:09:32+00:00 |
UpdatedDate | string | The time when the chat configuration was last updated. | 2025-12-28T13:59:48+00:00 |
RamRole | string | The name of the RAM role used to perform operations. | OOSServiceRole |
Type | string | The type of the chat configuration. Valid values:
TODO: This information was generated by AI based on recent API call logs. Please confirm its accuracy! | |
Outputs | string | The output information, which includes the webhook URL and the AES key. | {"URL": "https://1407907063606569.appflow.aliyunnes", "AesKey": "UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF"} |
Examples
Success response
JSON format
{
"RequestId": "4DB0****1234",
"ChatConfigurations": [
{
"Name": "test-wechat",
"CreatedDate": "2025-12-10T10:09:32+00:00",
"UpdatedDate": "2025-12-28T13:59:48+00:00",
"RamRole": "OOSServiceRole",
"Type": "WeChat",
"Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\", \"AesKey\": \"UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF\"}"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.