Message send response

The response from the API changes depending on whether you send a single message or a batch of messages. Please refer to the appropriate section below:

Single Submission Response Details

Successful Submission Response

Upon a successful send to the Omnichannel API you will receive a HTTP 201 and a JSON body in the following format:

PropertyTypeDescription
messageIdstringA unique id for this message
sentOnstringDate/Time (in UTC, ISO 8601 format) that the message sent was accepted.
statusstringOne of:
processing
failed
* sent
statusDetailsobjectSpecific details related to the current status.
_createdOnstringDate/Time (in UTC, ISO 8601 format) that the message was created.
_createdBystringThe profile id that created the message.
_updatedOnstringDate/Time (in UTC, ISO 8601 format) that the message was last updated.
_updatedBystringThe profile id that last updated the message.
{
  "_createdOn": "2017-03-17T14:22:40.633Z",
  "_updatedOn": "2017-03-17T14:22:40.633Z",
  "_createdBy": "access:3dd1558a-9db3-406a-8460-cbe5100a7628",
  "_updatedBy": "access:3dd1558a-9db3-406a-8460-cbe5100a7628",
  "to": {
    "phoneNumber": "447123123123"
  },
  "senderProfileId": "M0rsy",
  "body": "Your message",
  "rules": [
    "sms"
  ],
  "sentOn": "2017-03-17T14:22:40.627Z",
  "channelOptions": {
    "sms": {
      "from": "dotdigital",
      "allowUnicode": false
    }
  },
  "status": "processing",
  "statusDetails": {
    "channelId": "sms"
  },
  "messageId": "d8e296bb-97c4-4495-b98f-1e32e0b11628"
}

Failed Submission

If there are issues with the submitted request a HTTP 400 is returned with the body describing the validation errors.

πŸ“˜

Getting the final status for a message

Once submitted, we process your message and try to deliver it down one of the channels specified. It is still possible the message can fail at this stage if no channels accept the message. To find the final status of a message you can query it using the Get Status method, or register a Webhook to have data pushed to your systems.

πŸ‘

Full API Specification

Please see the full API specification for further details about sending messages with the Omnichannel API.

Batch Submission Response Details

Successful Submission Response

Once you successfully send to the Omnichannel API, you then receive a HTTP 202 and a JSON body. The JSON is an array of objects in the following format, one for each message submitted in the batch:

PropertyTypeDescription
indexintThe index of the message send request in the original batch submission this response is for.
messageIdstringThe unique identifier for the message. This id can be used to request status details and correlate inbounds and receipts to the original message.

🚧

Whats happens after sending a batch of messages

The messages are processed as fast as possible after submission, but it may take a few seconds before this process is finished, and the message is available for status updates. You can get updates on your messages statuses asynchronously using our webhooks system.

[
  {
    "index": 0,
    "messageId": "58bde0da-b380-4cb2-8dd1-ca74fc7a0cda"
  },
  {
    "index": 1,
    "messageId": "0aee96a8-09c9-4192-bf6d-c5f20a323956"
  }
]

Failed Submission

If there are issues with the submitted request a HTTP 400 is returned with the body describing the validation errors.

πŸ‘

Full API specification

Please see the full API specification for further details about sending messages with the Omnichannel API.