Automate DingTalk Alerts via CreateChatConfiguration API - OOS

You can create, update, query, and delete chat configurations for platforms such as DingTalk.

Operation description

Request Description

This API manages chatbot settings for instant messaging tools such as DingTalk, allowing you to create, update, retrieve, and delete chat configurations. You can use this API to implement fine-grained permission control for different users or user groups, specify a RAM role to execute operations, and add tags to each configuration for management and categorization.

When you call this API, ensure that the provided RegionId, ConversationId, and all parameters in the request body are accurate. Exercise caution when you handle sensitive information, such as the ClientId and ClientSecret fields. Do not disclose them to unauthorized parties.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:CreateChatConfiguration

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Region ID.	cn-hangzhou
Name	string	No	Configuration name.	chatops
Type	string	No	Chat platform type. Valid values: DingTalk: DingTalk. WeChat: WeChat.	DingTalk
RamRole	string	No	RAM role name.	AliyunOOSDefaultRole
Configuration	string	No	Chatbot configuration information in JSON format.	("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"}
ResourceGroupId	string	No	Resource group ID.	rg-acfmxsn4m4******

Response elements

Element	Type	Description	Example
	object	Details of a successful response.
RequestId	string	Request ID.	4DB0****1234
ChatConfiguration	object	Details of the chat configuration.	{"Name": "TestChatConfig-9be97b40", "CreatedDate": "2025-12-11T13:49:10+00:00", "UpdatedDate": "2025-12-11T13:59:02+00:00"}
Name	string	Name of the chat configuration.	TestChatConfig-9be97b40
CreatedDate	string	Creation time of the chat configuration.	2025-12-11T13:49:10+00:00
UpdatedDate	string	Last update time of the chat configuration.	2025-12-11T13:59:02+00:00

Examples

Success response

JSON format

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "TestChatConfig-9be97b40",
    "CreatedDate": "2025-12-11T13:49:10+00:00",
    "UpdatedDate": "2025-12-11T13:59:02+00:00"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.