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
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 Resourcesis 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 |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ChannelType | string | Yes | The channel type. Valid values: whatsapp, viber, and line. | |
| TemplateCode | string | Yes | The encoding of the message template. | 744c4b5c79c9432497a075bdfca36bf5 |
| Language | string | Yes | The language. For more information about language codes, see Language codes. | en |
| From | string | Yes | The phone number of the message sender. | 861387777**** |
CustWabaIddeprecated | string | No | The ID of the WhatsApp Business account under the ISV account. | 65921621816**** |
| FallBackId | string | No | The ID of the fallback strategy. | S00001 |
| FallBackContent | string | No | The fallback content. | Fallback message |
| TaskId | string | No | The ID of the task. | 100000001 |
| SenderList | array<object> | Yes | The phone numbers to which the message is sent. | |
| object | Yes | |||
| To | string | Yes | The phone number to which the message is sent. | 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. | |
| string | No | The payload. | ["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 | |||
| Title | string | No | The name of the category. | abcd |
| ProductItems | array<object> | No | The products. | |
| object | No | |||
| ProductRetailerId | string | No | The retailer ID of the product. | ksi399d8 |
| IsvCode | string | No | The ISV verification code, which is used to verify whether the 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 message type when the ChannelType parameter is set to viber. Valid values: promotion and transaction. | promotion |
| Tag | string | No | The tag information when the ChannelType parameter is set to viber. | tag |
| FallBackRule | string | No | The fallback rule. Note
Valid values:
| undelivered |
Response parameters
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": ""
}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 |