Call UpdateConversationalAutomation API to Automate WhatsApp Engagement - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Modifies the welcome message, conversation starters, and commands for a phone number.

Operation description

QPS limit

The single-user QPS limit for this API is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this API appropriately.

This API directly retrieves data from Facebook. Facebook imposes a limit on the total number of API calls. Use this API appropriately.

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

cams:UpdateConversationalAutomation

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnableWelcomeMessage	boolean	No	Specifies whether to enable the welcome message.	true
PhoneNumber	string	Yes	The business phone number.	86130000***
Commands	array<object>	No	The list of commands.
	object	No	The command object.
CommandDescription	string	No	The command description.	Command 1
CommandName	string	No	The command name.	test
Prompts	array	No	The list of conversation starters.
	string	No	The conversation starter information.	prompt1
CustSpaceId	string	Yes	The space ID of the ISV sub-customer or the instance ID of the direct customer.	2993****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccessDeniedDetail	string	The details about the access denial.	无
Message	string	The prompt message. This parameter is returned when an exception occurs.	无
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The response code. OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "无",
  "Message": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.