1. Whatsapp
  2. Contacts Message

Whatsapp

Contacts Message

Send a single or list of contacts 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 nested parameters for message_type: contacts 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.contacts

required
object

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

Default: null


params.contacts.address

optional
array

Contains address objects where each address object is as follows:

loading...

Default: null


params.contacts.emails

optional
array

Contains email objects where each email object is as follows:

loading...

Default: null


params.contacts.name

optional
array

Contains a name objects where each name object is as follows:

loading...

Default: null


params.contacts.org

optional
array

Contains a org objects where each org object is as follows:

loading...

Default: null


params.contacts.phones

optional
array

Contains a phones objects where each phones object is as follows:

loading...

Default: null


params.contacts.urls

optional
array

Contains a urls objects where each urls object is as follows:

loading...

Default: null


params.contacts.birthday

optional
string

The birthday of the contact.

Example: "2022-10-01"

Default: null


Result

Examples