One API: Request parameters

The table below highlights the definitions of the parameters that are utilized in the API calls.

Parameter Name Mandatory Type Description
messages Yes Array Subject header for the array of message objects
to Yes String Define the message destination in the international mobile number format
content Yes String The message body. For media messages, this will be the base64 encoded content of the media file being sent.
clientMessageId No String This is an optional parameter and may be utilized as an external reference by the user. Will be saved as an external reference only by Platform for future reporting options. This parameter will be returned in the send message response. This will allow the customer to map the clientMessageId to the messageId returned unambiguously – especially in the case where the customer submits more than one message in a single request. The sequence of responses is not guaranteed to be the same as the order in which messages were submitted.
contentType No String WhatsApp channel only parameter. Media type header for file format and file content. This parameter is required when sending a media message object.
previewFirstUrl No Bool WhatsApp channel only parameter. True or False – will indicate if URL link must display as preview on recipient phone.
caption No String WhatsApp channel only parameter. This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media.
template No String WhatsApp channel only parameter. Unique reference Id of a template that has been approved by WhatsApp for use specifically by the customer.
parameters No String WhatsApp channel only parameter. Values to apply to the variables within the requested message template.
relatedMessageId No String WhatsApp channel only parameter. This is a linked message ID that is returned if the user replies directly to an earlier message that was sent from your business.
The table below highlights the definitions of the parameters that are utilized in the API calls.
Parameter Name Mandatory Type Description
messages Yes Array Subject header for the array of message objects
to Yes String Define the message destination in the international mobile number format
content Yes String The message body. For media messages, this will be the base64 encoded content of the media file being sent.
clientMessageId No String This is an optional parameter and may be utilized as an external reference by the user. Will be saved as an external reference only by Platform for future reporting options. This parameter will be returned in the send message response. This will allow the customer to map the clientMessageId to the messageId returned unambiguously – especially in the case where the customer submits more than one message in a single request. The sequence of responses is not guaranteed to be the same as the order in which messages were submitted.
contentType No String WhatsApp channel only parameter. Media type header for file format and file content. This parameter is required when sending a media message object.
previewFirstUrl No Bool WhatsApp channel only parameter. True or False – will indicate if URL link must display as preview on recipient phone.
caption No String WhatsApp channel only parameter. This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media.
template No String WhatsApp channel only parameter. Unique reference Id of a template that has been approved by WhatsApp for use specifically by the customer.
parameters No String WhatsApp channel only parameter. Values to apply to the variables within the requested message template.
relatedMessageId No String WhatsApp channel only parameter. This is a linked message ID that is returned if the user replies directly to an earlier message that was sent from your business.