SMsmsportal
Messages

Send a free form engagement message.

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!"
}
post/whatsapp/v1/messages/engagement

Request

  • Base URL
    https://rest.smsportal.com
  • URL
    https://rest.smsportal.com/whatsapp/v1/messages/engagement
  • Auth
    HTTP basic

Request body

businessPhoneNumberIdstring required

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

recipientstring nullable

This field can contain a phone number or a BSUID.

destinationNumberstring nullable

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.

customerIdstring nullable

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

typestring nullable

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.

textstring nullable

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

Example request

{
  "businessPhoneNumberId": "841234567890"
}

Response

The template message was sent successfully

errorCodestring nullable required
errorDetailstring nullable required
businessPhoneNumberIdstring nullable required
recipientstring nullable required
destinationNumberstring nullable
customerIdstring nullable required
messageIdinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.