RequestWhatsappConversionApi - Chat App Message Service - Alibaba Cloud Documentation Center

Sends a request to the WhatsApp Conversions API.

Operation description

The China-specific QPS limit for a single user of this API operation is 100 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageId	string	Yes	The PageId of Meta.	1939848838
CustSpaceId	string	Yes	The space ID or instance ID of the customer.	929399382
RequestData	array<object>	No	The request data.
	array<object>	No	The request data.
DataProcessingOptionsState	integer	No	Required in some cases. (See the notes below for details.) The state you want to associate with this data processing option. Currently accepted values are 1000 (representing California) or 0 (requesting that we geolocate this event).	26
UserData	object	Yes	A map that contains customer information data.
	any	No	data	{"currency":"USD", "value": 1}
EventName	string	Yes	The name of a standard event or custom event. This field is used to deduplicate events sent by a website (through Meta Pixel), an app (through the SDK or App Events API), and the Conversions API. The event_id parameter is also used for deduplication. For the same customer action, the event from the browser or app should match the event_name from the server event. If a match is found between events sent within 48 hours, only the first event is considered. If server and browser/app events are received at approximately the same time (within 5 minutes of each other), the browser/app event takes priority. Learn more about deduplicating Pixel events and server events.	Purchase
OptOut	boolean	No	A flag that indicates this event should not be used for ad delivery optimization. When set to true, the event can only be used for attribution.	true
AppData	object	No	Required parameters for app events. These parameters are used to share app data and device information with the Conversions API.
	any	No	data	{}
EventTime	integer	Yes	A Unix timestamp in seconds indicating when the event actually occurred. The specified time may be earlier than the time you send the event to Facebook. This is intended for batch processing and server performance optimization. You must send the date in Greenwich Mean Time (GMT) time zone format.	1709201870
ExtInfo	object	No	Required parameters for app events. Extended device information, such as the width and height of the screen. This parameter is an array with values separated by commas. When using extinfo, all values are required and must be arranged in the following index order. If a value is missing, use an empty string as a placeholder.
	any	No	data	{}
CustomData	object	No	A map that contains additional business data for the event.
	any	No	data	{}
EventId	string	No	This ID can be any unique string chosen by the advertiser. The event_name and event_id parameters are used to deduplicate events sent by a website (through Meta Pixel), an app (through the SDK or App Events API), and the Conversions API. Although event_id is marked as optional, we recommend that you use this parameter for deduplication.	20029399299
DataProcessingOptions	array	No	The processing options you want to enable for a specific event. For Limited Data Use, the currently accepted value is LDU. You can send an empty array to explicitly specify that the event must not be processed with Limited Data Use restrictions.
	string	No	data	[]
MessagingChannel	string	No	The source. Fixed value: whatsapp.	whatsapp
ActionSource	string	Yes	Specifies where the conversion occurred. Knowing where the event occurred helps ensure that ads are delivered to the correct audience. By using the Conversions API, you agree that the action_source parameter is accurate to the best of your knowledge. The values you can send in the action_source field are as follows: email: The conversion occurred through email. website: The conversion was made on a website. app: The conversion was made on a shift application. phone_call: The conversion was made over the phone. chat: The conversion was made through a messaging app, SMS, or online messaging feature. physical_store: The conversion was made in person at a physical store entity. system_generated: The conversion occurred automatically, such as a subscribe renewal with Settings for monthly automatic payment. other: The conversion was made through a method not listed in this topic. Note: All action source values support ads measurement and custom audience creation. All action sources except physical_store support ads optimization.	business_messaging
DataProcessingOptionsCountry	integer	No	Required if you send LDU under data_processing_options. The country you want to associate with this data processing option. Currently accepted values are 1 (representing the United States) or 0 (requesting that we geolocate this event).	100
EventSourceUrl	string	No	The browser URL where the event occurred. The URL must start with http:// or https:// and should match the verified domain.	http://alibaba.com

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The access denied details.	None
Message	string	The error message.	example
RequestId	string	The request ID.	example
Code	string	The response code. A value of 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 false.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "example",
  "RequestId": "example",
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.