Response structure

If the request was successful, the response contains the information for the calling application to retrieve information about the message.

If the request was not successful, the response will contain the information about why the request could not be processed. This will be as per the standard Whispir API response code rules.

In the case of a dynamic message, the outcome of this message will be a complete message with placeholder variables @@ replaced with the supplied values.

For more information about retrieving responses and the status of a sent message see Message status.

  • JSON
  • XML

If the /message call is successful the following response will be received:


HTTP 1.1 202 Accepted
Location: https://api.<region><your_api_key>

Your request has been accepted for processing.


The Location value in the Header contains the messageId (for the sent message) as shown in the response above.