Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.
Operation description
Description
This API manages chatbot settings for integrations with instant messaging tools, such as DingTalk. Operations include creating new chat configurations, updating existing ones, retrieving configuration details, and deleting configurations. This API lets you implement fine-grained permission control for different users or user groups and specify a Resource Access Management (RAM) role to execute operations. You can also add tags to each configuration for management and classification.
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 disclosure to unauthorized parties.
Try it now
Test
RAM authorization
Request parameters
Parameter | Type | Required | Description | Example |
RegionId | string | No | The region ID. | cn-hangzhou |
Name | string | No | The name of the chat configuration. | Ginlong-AIops |
Type | string | No | The type of the chat platform. Valid values:
| DingTalk |
RamRole | string | No | The name of the RAM role. | AliyunOOSLifecycleHook4CSRole |
Configuration | string | No | The specific parameters for the chat configuration, typically in JSON format. | ("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"} |
ResourceGroupId | string | No | The ID of the resource group. | rg-2cd3****9dc2 |
Response elements
Element | Type | Description | Example |
object | The details of the successful response. | ||
RequestId | string | The request ID. | 4DB0****1234 |
| ChatConfiguration | object | The chat configuration information, including the configuration name, creation time, and update time. | {"Name": "dingtalk", "CreatedDate": "2025-12-23T10:14:28+00:00", "UpdatedDate": "2025-12-23T10:16:37.178097"} |
Name | string | The configuration name. | dingtalk |
CreatedDate | string | The time when the configuration was created. The format is ISO 8601. | 2025-12-23T10:14:28+00:00 |
UpdatedDate | string | The time when the configuration was last updated. The format is ISO 8601. | 2025-12-23T10:16:37.178097 |
Examples
Success response
JSON format
{
"RequestId": "4DB0****1234",
"ChatConfiguration": {
"Name": "dingtalk",
"CreatedDate": "2025-12-23T10:14:28+00:00",
"UpdatedDate": "2025-12-23T10:16:37.178097"
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.