SendChatappMassMessage - Chat App Message Service - Alibaba Cloud Documentation Center

Sends a message to multiple phone numbers by using ChatAPP at a time.

Operation description

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

You can send messages to up to 1,000 phone numbers in a single request.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cams:SendChatappMassMessage	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ChannelType	string	Yes	The type of the channel. Valid values: whatsapp viber line (under development)	whatsapp
TemplateCode	string	No	The template code.	744c4b5c79c9432497a075bdfca36bf5
Language	string	Yes	The language. For more information about language codes, see Language codes.	en
From	string	Yes	The mobile phone number of the message sender.	861387777****
CustWabaId`deprecated`	string	No	The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account. Note CustWabaId is an obsolete parameter. Use CustSpaceId instead.	65921621816****
FallBackId	string	No	The ID of the fallback policy.	S00001
FallBackContent	string	No	The content of the fallback message.	Fallback message
TaskId	string	No	The task ID.	100000001
SenderList	array<object>	Yes	The mobile phone numbers of the message receivers.
	object	Yes	The mobile phone numbers of the message receivers.
To	string	Yes	The mobile phone number of the message receiver.	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	array<object>	No	The products. Up to 30 products and 10 categories can be added.
	object	No	The category of the product.
Title	string	No	The name of the category.	abcd
ProductItems	array<object>	No	The products.
	object	No	The information about the product.
ProductRetailerId	string	No	The retailer ID of the product.	ksi399d8
FlowAction	object	No	The Flow action.
FlowToken	string	No	The information about the Flow token.	kde****
FlowActionData	object	No	The default parameter of the Flow.
	string	No	The default parameter of the Flow.	{"name":"name"}
IsvCode	string	No	The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.	skdi3kksloslikdkkdk
CustSpaceId	string	No	The space ID of the user.	28251486512358****
Ttl	long	No	The timeout period for sending messages when the ChannelType parameter is set to viber. Valid values: 30 to 1209600. Unit: seconds.	50
Label	string	No	The type of the Viber message. Valid values: promotion transaction	promotion
Tag	string	No	The tag information when the ChannelType parameter is set to viber.	tag
FallBackDuration	integer	No	Specifies the period of time after which the fallback message is sent if the message receipt that indicates the message is delivered to clients is not received. If this parameter is left empty, the fallback message is sent only when the message fails to be sent or the message receipt that indicates the message is not delivered to clients is received. Unit: seconds. Valid values: 60 to 43200.	120
FallBackRule	string	No	The fallback rule. Valid values: undelivered: A fallback is triggered if the message is not delivered to clients. When the message is being sent, the template parameters are verified. If the parameters fail to pass the verification, the message fails to be sent. Whether the template and phone number are prohibited is not verified. By default, this value is used when FallBackRule is left empty. sentFailed: A fallback is triggered even if the template parameters including variables fail to pass the verification. If the channelType, type, messageType, to, and from parameters fail to pass the verification, a fallback is not triggered.	undelivered
TemplateName	string	No	The name of the message template.	test_name

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-10	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-03-14	The Error code has changed	View Change Details
2023-11-21	The Error code has changed	View Change Details
2023-09-21	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-08-01	The Error code has changed	View Change Details
2023-07-04	The Error code has changed. The response structure of the API has changed	View Change Details
2023-04-13	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-11-17	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-09-30	The Error code has changed	View Change Details
2022-08-18	Add Operation	View Change Details