Send a WhatsApp message to multiple phone numbers

Call SendChatappMassMessage to send a WhatsApp message to up to 1,000 phone numbers in a single request.

API description

Call SendChatappMassMessage to send a WhatsApp message to multiple phone numbers.

This operation supports up to 10 calls per second per account. Exceeding this limit triggers throttling.

Each request supports up to 1,000 phone numbers.

Debugging

Call this operation in OpenAPI Explorer to auto-generate signature values and SDK sample code.

Authorization information

Use the following authorization information in the Action policy element to grant RAM users or roles permission to call this operation.

Operation: the value for the Action policy element.
Access level: read, write, or list.
Resource type: the resource on which you can authorize this operation.
- Required resource types are shown in bold.
- If resource-level permissions are not supported, All Resources is shown.
Condition Key: the condition key defined by the service.
Associated operation: other operations required to complete this operation.

Operation	Access level	Resource type	Condition key	Associated operation
cams:SendChatappMassMessage	Write	acs:cams::{#accountId}:*	None	None

Request parameters

Parameter					Type	Required	Description	Example
ChannelType					string	Yes	The channel type. Set to whatsapp.	whatsapp
TemplateCode					string	Yes	The template code.	744c4b5c79c9432497a075bdfca36bf5
Language					string	Yes	The language. For more information about language codes, see Language codes.	en
From					string	Yes	The sender's phone number.	861387777****
FallBackId					string	No	The ID of the fallback policy.	S00001
FallBackContent					string	No	The content of the fallback message.	Fallback text message
TaskId					string	No	The task ID.	100000001
SenderList					object []	Yes	The list of recipient phone numbers and per-recipient parameters.
	To				string	Yes	The recipient's phone number.	861388988****
	TemplateParams				object	No	The parameters of the template.
					string	No	The parameters of the template.	{"param1":"value1","param2":"value2"}
	Payload				array	No	The payload of the button.
					string	No	The payload of the button.	["payloadtext1","payloadtext2","payloadtext3"]
	ProductAction				object	No	The information about the product.
		ThumbnailProductRetailerId			string	No	The retailer ID of the product.	skkks999393
		Sections			object []	No	The products. Up to 30 products and 10 categories can be added.
			Title		string	No	The name of the category.	abcd
			ProductItems		object []	No	The products.
				ProductRetailerId	string	No	The retailer ID of the product.	ksi399d8
	FlowAction				object	No	The action of the WhatsApp flow.
		FlowToken			string	No	The information about the flow token.	kde99d8
		FlowActionData			object	No	The default parameters of the flow.
					string	No	The default parameter of the flow.	{"name":"name"}
CustSpaceId					string	No	The space ID of the user within RAM.	28251486512358****
FallBackDuration					integer	No	The timeout in seconds before the fallback message is sent. If unset, the fallback is sent only when the message fails to be sent or is confirmed undelivered. Valid values: 60 to 43200.	120
FallBackRule					string	No	The fallback rule. Valid values: undelivered: triggers a fallback when the message is not delivered. Template parameters are verified before sending; verification failure prevents the message from being sent. Whether the template and phone number are prohibited is not verified. This is the default value. sentFailed: triggers a fallback even when template parameter verification fails. Core parameters (channelType, type, messageType, to, from) are still validated.	undelivered

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	The response status code. OK indicates success. Other values indicate that the request fails. For more information, see API error codes.	OK
Message	string	The error message.	User not authorized to operate on the specified resource.
GroupMessageId	string	The message group ID.	890000010002****
AccessDeniedDetail	string	The access denial details.	None

Example

Sample success responses

JSON format

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "GroupMessageId": "890000010002****",
  "AccessDeniedDetail": "None"
}

Error codes

HTTP status code	Error code	Error message
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

All error codes are documented in Service error codes.