DingTalk Chat Configuration API Overview - OOS

Creates, updates, retrieves, and deletes chat configurations for platforms such as DingTalk.

Operation description

Request description

This API is used to create, update, retrieve, and delete chatbot configurations for integrations with instant messaging (IM) tools, such as DingTalk. The API provides fine-grained permission control for different users or user groups. You can also specify a RAM role to execute operations and add tags to configurations for easier management and categorization.

Ensure that the RegionId, ConversationId, and all parameters in the request body are accurate when you call this API. Handle sensitive information, such as the ClientId and ClientSecret fields, with care to prevent disclosure 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Name	string	No	The configuration name.	chatOps-qiwei

Response elements

Element	Type	Description	Example
	object	The details of the successful response.
RequestId	string	The request ID.	4DB0****1234
ChatConfiguration	object	The details of the chat configuration. This includes properties such as the name, type, and RAM role.	{ "Name": "chatops", "Type": "DingTalk", "RamRole": "OOSServiceRole", "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"****\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}", "ResourceGroupId": "s", "CreatedDate": "2025-12-26T09:53:02+00:00", "UpdatedDate": "2026-01-07T02:14:55+00:00", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}", "RequestId": "4DB0**1234" }
Name	string	The name of the chat configuration.	chatops
Type	string	The type of the chat configuration. Valid values: DingTalk: A DingTalk configuration. WeChat: A WeCom configuration. TODO: This information was generated by AI based on recent API call logs. Please verify its accuracy.	DingTalk
RamRole	string	The name of the RAM role used to execute operations.	OOSServiceRole
Configuration	string	The specific content of the chat configuration. This is a JSON string that contains sensitive information, such as the client ID and key.	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	The ID of the resource group to which the resource belongs.	s
CreatedDate	string	The time when the chat configuration was created. The format is ISO 8601.	2025-12-26T09:53:02+00:00
UpdatedDate	string	The time when the chat configuration was last updated. The format is ISO 8601.	2026-01-07T02:14:55+00:00
Outputs	string	The output information of the chat configuration. This is a JSON string that contains parameters such as the webhook URL.	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

Examples

Success response

JSON format

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "chatops",
    "Type": "DingTalk",
    "RamRole": "OOSServiceRole",
    "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"******\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}",
    "ResourceGroupId": "s",
    "CreatedDate": "2025-12-26T09:53:02+00:00",
    "UpdatedDate": "2026-01-07T02:14:55+00:00",
    "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.