1. Whatsapp
  2. Text Message

Whatsapp

Text Message

Send a text message through whatsapp.

Basic Usage

loading...

Parameters

Everything inside platforms.meta_whatsapp should be considered parameters for this notification. There are top level parameters that describe the message type and other general message behaviours, and then there are nested parameters dependent on the message type.

Only message_type and nested parameters for message_type: text is explained here, for all top level parameters, see the top level Whatsapp documentation

message_type

required
string

Indicates the type of message that is going to be sent. This also will determine what the contents of the params object should be.

Available message types are:


params

required
object

Contains the parameters for the message and will depend on the message_type setting. See the message_type specific documentation above for the message type specific parameters.


params.text

required
object

Object is required if the message_type is text. This object should change to match what message_type is set to.


params.text.body

required
string

Contains the actual message that will be sent.

Default: null


params.text.preview_url

required
boolean

Enables / disables the URL Preview in the message the user will see. If enabled, any URL in the message will be given a thumbnail preview of the destination.

Default: true


Result

Examples