09 April 2019

One API: Request parameters

09 April 2019
clock
2 minutes

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.

Featured Insight Circle post

Seeing the world through the eyes of your user – Part I

Related blogs posts

Seeing the world through the eyes of your user – Part I
A View of the Future with Dr. Damian Tan
Sterling Bank Enhances Digital Banking with Clickatell

About Clickatell

Todays’ consumers spend more time on chat like text, Instagram, Facebook Messenger, and WhatsApp than apps, and they expect a high degree of convenience in the way brands serve them. Clickatell makes it possible for brands and consumers to engage and transact via mobile chat and digital channels with industry-leading communications commerce platforms and solutions. With offices in San Francisco, Toronto, Cape Town, and Lagos, Clickatell serves more than 15,000 global brands, ranging from Fortune 500 organizations to well-known consumer brands and small businesses in over 220 countries worldwide.

Read more about Clickatell

Related blogs posts

Seeing the world through the eyes of your user – Part I
A View of the Future with Dr. Damian Tan
Sterling Bank Enhances Digital Banking with Clickatell

This website uses cookies to allow us to see how the site is used. The cookies cannot identify you. If you continue to use this site we will assume that you are happy with this. If you want to use the site without cookies or would like to know more, you can do that here.