All Products
Search
Document Center

ChatApp Message Service:SendChatappMassMessage

Last Updated:Mar 01, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ChannelTypestringYes

The channel type. Valid values: whatsapp, viber, and line.

whatsapp
TemplateCodestringYes

The encoding of the message template.

744c4b5c79c9432497a075bdfca36bf5
LanguagestringYes

The language. For more information about language codes, see Language codes.

en
FromstringYes

The phone number of the message sender.

861387777****
CustWabaIddeprecatedstringNo

The ID of the WhatsApp Business account under the ISV account.

65921621816****
FallBackIdstringNo

The ID of the fallback strategy.

S00001
FallBackContentstringNo

The fallback content.

Fallback message
TaskIdstringNo

The ID of the task.

100000001
SenderListobject []Yes

The phone numbers to which the message is sent.

TostringYes

The phone number to which the message is sent.

861388988****
TemplateParamsobjectNo

The parameters of the template.

stringNo

The parameters of the template.

{"param1":"value1","param2":"value2"}
PayloadarrayNo

The payload.

stringNo

The payload.

["payloadtext1","payloadtext2","payloadtext3"]
ProductActionobjectNo

The information about the product.

ThumbnailProductRetailerIdstringNo

The retailer ID of the product.

skkks999393
Sectionsobject []No

The products. Up to 30 products and 10 categories can be added.

TitlestringNo

The name of the category.

abcd
ProductItemsobject []No

The products.

ProductRetailerIdstringNo

The retailer ID of the product.

ksi399d8
IsvCodestringNo

The ISV verification code, which is used to verify whether the user is authorized by the ISV account.

skdi3kksloslikdkkdk
CustSpaceIdstringNo

The space ID of the user.

28251486512358****
TtllongNo

The timeout period for sending messages when the ChannelType parameter is set to viber. Valid values: 30 to 1209600. Unit: seconds.

50
LabelstringNo

The message type when the ChannelType parameter is set to viber. Valid values: promotion and transaction.

promotion
TagstringNo

The tag information when the ChannelType parameter is set to viber.

tag
FallBackRulestringNo

The fallback rule.

Note Valid values:
  • undelivered: A fallback is triggered if the WhatsApp message is not delivered to clients. When the WhatsApp 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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

90E63D28-E31D-1EB2-8939-A9486641****
Codestring

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
Messagestring

The error message returned.

User not authorized to operate on the specified resource.
GroupMessageIdstring

The ID of the group of messages.

890000010002****

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 codeError codeError message
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

Change history

Change timeSummary of changesOperation
2023-11-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-09-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: FallBackRule
2023-08-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-07-04The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-04-13The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: FallBackDuration
2022-11-17The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CustSpaceId
2022-09-30The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2022-08-18Add Operationsee changesets