Contacts Message
Send a single or list of contacts through Whatsapp.
Basic Usage
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
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
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
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
Contains address objects where each address object is as follows:
Default: null
params.contacts.emails
Contains email objects where each email object is as follows:
Default: null
params.contacts.name
Contains a name objects where each name object is as follows:
Default: null
params.contacts.org
Contains a org objects where each org object is as follows:
Default: null
params.contacts.phones
Contains a phones objects where each phones object is as follows:
Default: null
params.contacts.urls
Contains a urls objects where each urls object is as follows:
Default: null
params.contacts.birthday
The birthday of the contact.
Example: "2022-10-01"
Default: null