Sending an MT WhatsApp Message (sendWhatsappMessage)

Updated on 2023-09-27 GMT+08:00

View PDF

Scenario

This interface is invoked to send an MT WhatsApp message.

Method

POST

URI

https://Domain name/apiaccess/rest/ccmessaging/omni/1/advanced (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)
2	x-app-key	String	Yes	App key, which is the user ID and is configured on the API Fabric
3	Content-Type	String	Yes	Content type

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	scenarioKey	String	No	Unique key of the solution that will be used to send messages. If this field is not set, the default solution is used. The AICC does not send this field.
1.2	bulkId	String	Yes	Unique request ID. Multiple IDs will be received only when the message is sent to multiple destination addresses.
1.3	destinations	Array [Object]	Yes	List of message recipients
1.3.1	messageId	String	Yes	Unique ID of a sent message
1.3.2	to	Object	Yes	Message destination address
1.3.2.1	phoneNumber	String	Yes	Destination phone number. The value must be in the international number format, for example, 41793026727.
1.4	whatsApp	whatsApp	Yes	Encapsulated whatsApp object
1.5	sendAt	String	No	Date and time when the message needs to be sent. This parameter is used for scheduled OMNI messaging. The first message in the OMNI flow is not sent immediately, but will be sent at the scheduled time.

**Table 3** whatsApp parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	text	String	No	Text of the message to be sent
1.2	imageUrl	String	No	URL of the image sent in the WhatsApp message. The value can contain a maximum of 2048 characters. The image type must be JPG, JPEG, or PNG. The image size cannot exceed 2 MB.
1.3	audioUrl	String	No	URL of the audio file sent in the WhatsApp message. The value can contain a maximum of 2048 characters. The audio type must be AAC. The audio size cannot exceed 2 MB.
1.4	videoUrl	String	No	URL of the video sent in the WhatsApp message. The value can contain a maximum of 2048 characters. The video type must be MP4. The video size cannot exceed 10 MB.
1.5	locationName	String	No	Text of the message to be sent The value contains a maximum of 1000 characters.
1.6	address	String	No	Address. This parameter is optional. The value contains a maximum of 1000 characters.
1.7	longitude	Number	No	Longitude. The value ranges from –180 to 180.
1.8	latitude	Number	No	Latitude. The value ranges from –90 to 90.
1.9	templateName	String	No	Template name
1.10	templateData	Array [String]	No	Template parameter values sorted by registration sequence in the template
1.11	language	String	No	Code of the language or locale to be used. The code must be the same as that used for registration in the template.
1.12	mediaTemplateData	mediaTemplateData	No	Encapsulated mediaTemplateData object

**Table 4** mediaTemplateData parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	header	HeaderObject	No	Media template type. This parameter is required for media templates with titles.
1.2	body	BodyObject	No	Media template body
1.3	buttons	Array [Object]	No	Media template buttons

**Table 5** HeaderObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	textPlaceholder	String	No	Text placeholder. This parameter is required for templates with text titles.
1.2	imageUrl	String	No	Image URL. This parameter is required for templates with image titles. The image type must be JPG, JPEG, or PNG. The image size cannot exceed 2 MB.
1.3	videoUrl	String	No	Video URL. This parameter is required for templates with video titles. The video type must be MP4. The video size cannot exceed 10 MB.
1.4	latitude	Number	No	Latitude. The value ranges from –90 to 90. This parameter is required for templates with location titles.
1.5	longitude	Number	No	Longitude. The value ranges from –180 to 180. This parameter is required for templates with location titles.

**Table 6** BodyObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	placeholders	Array [String]	No	Media template body placeholders. The value cannot be null, but can be an empty array. Values within the array cannot be null or empty.

**Table 7** ButtonObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	urlPlaceholder	String	No	Date and time when the message needs to be sent. This parameter is used for scheduled OMNI messaging. The first message in the OMNI flow is not sent immediately, but will be sent at the scheduled time.
1.2	quickReplyPayload	String	No	Quick reply payload. This parameter is required for the quick reply button.

**Table 8** destinations parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	messageId	String	Yes	Unique ID of a sent message
1.2	to	toObject	Yes	Message destination address

**Table 9** MessageObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	to	toObject	No	Message destination address
1.2	status	StatusObject	No	Message status. The message states include successfully sent, not sent, passed, not passed, and waiting for passing.
1.3	messageId	String	No	Unique ID of a sent message

**Table 10** toObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	phoneNumber	String	Yes	Destination phone number. The value must be in the international number format, for example, 41793026727.

**Table 11** StatusObject parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	groupName	String	Yes	Status group name
1.2	id	Integer	Yes	Status ID
1.3	groupId	Integer	Yes	Status group ID
1.4	name	String	Yes	Status name
1.5	action	String	No	Action to be taken to eliminate errors
1.6	description	String	Yes	Readable status description

Response Description

Status code: 200

**Table 12** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	messages	Array [Object]	Yes	Array of sent message objects. Each message corresponds to an object.
1.1.1	to	Object	Yes	Message destination address
1.1.1.1	phoneNumber	String	Yes	Destination phone number. The value must be in the international number format, for example, 41793026727.
1.1.2	status	Object	Yes	Status object
1.1.2.1	groupId	Number	Yes	Status group ID
1.1.2.2	groupName	String	Yes	Status group name
1.1.2.3	id	Number	Yes	Status ID
1.1.2.4	name	String	Yes	Status name
1.1.2.5	description	String	Yes	Readable status description
1.1.2.6	action	String	No	Action to be taken to eliminate errors
1.1.3	messageId	String	Yes	Unique ID of a sent message
1.2	bulkId	String	Yes	Unique request ID

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Incorrect request. Check the values of parameters in the request.

Error Codes

None

Example

Scenario: OAuth authentication is supported when WhatsApp sends a template message.

URL: successful request message

Request header:

{    "x-app-key": "268e19b9-aae6-488a-bec6-5c9a67692946",    "Authorization": "Bearer 2febd549********************b9daff1",    "Content-Type": "application/json"}

Request parameters:

{
    "bulkId": "2853BC8B21D23F473AB9AE41B75F34FC18D322B91B01F60FAF206ACEBA9EF7BD",
    "whatsApp": {
        "templateName": "1",
        "templateData": [],
        "language": "zh_CN"
    },
    "destinations": [
        {
            "messageId": "46dbab11-f9cc-4d32-852b-cbba988b7d08",
            "to": {
                "phoneNumber": "155****8467"
            }
        }
    ]
}

Response parameters:

{
    "messages": [
        {
            "messageId": "10011",
            "to": {
                "phoneNumber": "173****6067"
            },
            "status": {
                "groupName": "send-test",
                "groupId": 113,
                "name": "sendMessage",
                "description": "description",
                "id": 1
            }
        }
    ],
    "bulkId": "20221025"
}

Parent topic: Web Client Access Interface Reference

Previous topic: Discarding an Email (chat_dropMail)

Next topic: Querying Information About the Current Chat on the Online Chat Workbench (getUserInfoBycallId)