Sending an MT WhatsApp Message (sendWhatsappMessage)

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

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.

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

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

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.

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.

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.

1.1

messageId

String

Yes

Unique ID of a sent message

1.2

to

toObject

Yes

Message destination address

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

1.1

phoneNumber

String

Yes

Destination phone number. The value must be in the international number format, for example, 41793026727.

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