ListChatConfigurations-阿里云帮助中心

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

Operation description

This API operation is used to manage and configure chatbot settings integrated with instant messaging tools such as DingTalk. Supported operations include creating chat configurations, updating existing configurations, retrieving specific configuration details, and deleting configurations that are no longer needed. You can use this API operation to implement fine-grained access control for different users or user groups and specify RAM roles to perform related operations. You can also add tags to each configuration for easier management and categorization.

When you call this API operation, make sure that the RegionId, ConversationId, and other parameters in the request body are correct. Exercise caution when handling security-sensitive fields such as ClientId and ClientSecret to prevent unauthorized disclosure.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Filters	array<object>	No	The list of filter conditions used to filter chat configurations.	[{"Name": "status", "Value": "inactive"}, {"Name": "type", "Value": "private"}]
	object	No	The filter condition item, which contains 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 per page for a paged query.	10
NextToken	string	No	The pagination token. Set this parameter to the value of NextToken that was returned from the last API call.	AQEBARoBBgEAAgIBBQ==

Response elements

Element	Type	Description	Example
	object	The details of the successful response.
RequestId	string	The request ID.	4DB0****1234
ChatConfigurations	array<object>	The 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 information about a single 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. The time is in ISO 8601 format in UTC.	2025-12-10T10:09:32+00:00
UpdatedDate	string	The time when the chat configuration was last updated. The time is in ISO 8601 format in UTC.	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: WeChat: WeCom. DingTalk: DingTalk. TODO: This information is generated by AI based on recent API call logs. Confirm the accuracy of this information.	WeChat
Outputs	string	The output information, including the webhook URL and encryption 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.