1. Whatsapp
  2. Media Message

Whatsapp

Media Message

Send a media message (image, pdf, voicenote) 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: media 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.media

required
object

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

Default: null


params.media.caption

required
object

The caption, or text, that will be send alongside the media. This is not supported for all media types.

Default: null


params.media.files

required
array

Contains the files (at this moment, only 1 file is supported in the array.) to be sent over whatsapp. The file should be a Stubber file of the following format:

loading...

Technically, only the fileuuid is required since the rest of the properties are already stored on Stubber for all Stubber files.

The easiest way to input a file into this parameter is by interpolating/substituting a full file. Examples:

  • ~~stubpost.data.files[0] where files is a file field
  • ~~stub.attachments[0]

Default: null


Result

Examples