Send a free form engagement message.

post

https://rest.smsportal.com/whatsapp/v1/messages/engagement

A free form message can only be sent while the destination number is in the customer service window.

Example request:

POST /whatsapp/v1/messages/engagement
{
"businessPhoneNumberId": "841234567890",
"recipient": "27000000001",
"content": "Hello World!"
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

businessPhoneNumberId

string

required

length ≥ 1

The id of the business phone number to send the message from

recipient

string | null

This field can contain a phone number or a BSUID.

destinationNumber

string | null

This is a legacy field that we are keeping around until all customers have migrated to using the Recipient field. It is recommended to use the Recipient field instead of this one.

customerId

string | null

Optional identifier that can be supplied at send time to help customers track their messages

type

string | null

WhatsApp supports [address, audio, contacts, document, image, interactive, location, location request, reaction, sticker, template, text and video].
This field specifies what type of message is being sent.

text

string | null

The text content of the message. Populated when Type is "text".

image

object

sticker

object

video

object

audio

object

document

object

interactive

object

location

object

contacts

array of objects | null

Contacts payload. Populated when Type is "contacts".

contacts

recipientIdentity

object

Responses

200The template message was sent successfully

400The template send was invalid, see the ErrorDetail

401The request was not properly authorized

500Something unexpected went wrong, please try again