Receiving messages

Inbound messages

In this section, you can find sample messages of every inbound message type supported by the Channels API from an SMS channel. The code snippets in every subsection demonstrate how an SMS message is converted into a Channels API message.

See the following pages to understand more about retrieving messages or message statuses

Text message

{
  "id": "96a0b5fa-a986-453d-be5c-3117f989f025",
  "channelId": "614208aa-b153-4d5d-9989-2fddfc0ce4c3",
  "sender": {
    "contact": {
      "id": "32cf5eee-f940-422c-ab8c-5f753aad5efd",
      "identifierKey": "phonenumber",
      "identifierValue": "[phone]"
    }
  },
  "receiver": {
    "connector": {
      "id": "86cc4dc0-3dc0-41b7-ac43-8ec829ead56f"
    }
  },
  "body": {
    "type": "text",
    "text": {
      "text": "Sample incoming text message"
    }
  },
  "parts": [
    {
      "platformReference": "e8077d803532c0b5937c639b60216938"
    }
  ],
  "status": "delivered",
  "direction": "incoming",
  "lastStatusAt": "2022-12-22T08:32:50.736Z",
  "createdAt": "2022-12-22T08:32:50.736Z",
  "updatedAt": "2022-12-22T08:32:50.736Z"
}

Webhook Callback for Incoming Message

The POST request sent to the webhook subscription URL will have the following structure:

{
    "service": "channels",
    "event": "sms.inbound",
    "payload": {} // object as shown in example above
}