Set Up WhatsApp Conversational Automation with GetConversationalAutomation API - Chat App Message Service

Operation description

QPS limit

This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

This operation retrieves data directly from Meta. Meta imposes its own rate limits on the total number of calls. Stay within the specified limit.

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
CustSpaceId	string	Yes	The space ID of the ISV sub-customer or the instance ID.	cams-3ie***
PhoneNumber	string	Yes	The phone number of the enterprise.	86130000***

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data.
Prompts	array	The opening remarks.
	string	The opening remark.	prompt1
Commands	array<object>	The commands.
	object	The command.
CommandDescription	string	The description of the command.	description
CommandName	string	The name of the command.	common1
PhoneNumber	string	The phone number of the enterprise.	861380000****
EnableWelcomeMessage	boolean	Indicates whether the welcoming message is enabled.	true
Code	string	The response code. The value OK indicates that the request was successful. For more information about other response codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Prompts": [
      "prompt1"
    ],
    "Commands": [
      {
        "CommandDescription": "description",
        "CommandName": "common1"
      }
    ],
    "PhoneNumber": "861380000****",
    "EnableWelcomeMessage": true
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.