Loader

WhatsApp RESTful API parameters overview

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

Parameter
Description
messages Subject header for the array of message objects.
to Define the message destination in the international mobile number format.
content The message body. For media messages, this will be the base64 encoded content of the media file being sent.
contentType Media type header for file format and file content. This parameter is required when sending a media message object.
encryptionKey The encryptionKey must be the base64 encoded ciphertext blob with which the encryption was done. This is an optional parameter available in the REST API. When you specify the encryption key, the message content will be handled as an encrypted string. Note: if you do not specify this value when the content is indeed encrypted, the logic will handle the content as unencrypted and message will be delivered as garbled characters.
sha256Hash SHA256 hash of the file sent in the media message. This hash must be calculated before the file is encrypted and will serve as verification that successful decryption took place before submission to the WhatsApp E-API. This is a required parameter for encrypted media messages.
clientMessageId 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.
previewFirstUrl True or False – will indicate if URL link must display as preview on recipient phone.
caption This is an optional parameter and may be used to describe the media file being sent. Do not use when sending audio media.
template Unique reference Id of the preapproved message template to be used in the Send Message API.
parameters Values to apply to the variables within the requested message template.
relatedMessageId This is a linked message ID that is returned if the user replies directly to an earlier message that was sent from your business platform and will allow you to manage a conversation thread.
from The mobile number of the user that is sending an incoming reply message.
statusCode Unique code for the status.
status Description of the status code.
errorCode The error code.
error The error description.
messageId This is the unique message ID returned in the response after the message is successfully accepted.
accepted True or False status.
integrationName The name that was registered for the integration used to deliver your messages.
integrationId Unique 32-digit alphanumeric identifier of the integration.
timestamp The UNIX timestamp.

 

Did you find this information informative?

Other Resources

Ask the Community

Visit Stack Overflow to join our community of developers and find the answer you need

Contact Support

Contact our support team and one of our agents will be in touch with you to answer any questions you have