GET
/
v1
/
message
/
list
List messages
curl --request GET \
  --url https://api.sendo.dev/v1/message/list
{
  "messages": [
    {
      "id": "f7d258bd-f697-4840-b8a6-165707e12345",
      "type": "SMS",
      "createdAt": "2023-09-19T04:55:50.723Z",
      "sentAt": "2023-09-19T04:55:50.723Z",
      "updatedAt": "2023-09-19T04:55:55.884Z",
      "direction": "INBOUND",
      "from": "+14159436397",
      "to": "+12061234567",
      "body": "Incoming message",
      "numSegments": 1,
      "campaignId": "U7fQ3123",
      "status": "DELIVERED"
    },
    {
      "id": "f7d258bd-f697-4840-b8a6-165707e12123",
      "type": "MMS",
      "createdAt": "2023-09-19T04:55:50.723Z",
      "sentAt": "2023-09-19T04:55:50.723Z",
      "updatedAt": "2023-09-19T04:55:55.884Z",
      "direction": "INBOUND",
      "from": "+14159436397",
      "to": "+12061234567",
      "body": "Another incoming message",
      "mediaUrls": ["https://example.com/image.jpg"],
      "numSegments": 1,
      "campaignId": "U7fQ3123",
      "metadata": {
        "customId": "123456789"
      },
      "status": "DELIVERED"
    },
    And so on...
  ]
}

​
URL Params

​
campaign
string
required
The ID of the campaign to list messages from.
​
limit
number
The number of messages to return (default 10).
​
skip
number
The number of messages to skip (i.e. offset).
​
direction
string
Return either INBOUND or OUTBOUND messages.
​
number
string
Return messages to/from a specific number.

​
Response

​
messages
[message]
An array of message objects returned.
​
error
string
Error message if the request fails.

​
Errors

If the request fails, it will return an HTTP error status code and an error field in the response body with details. Full list of status codes here. 
{
  "messages": [
    {
      "id": "f7d258bd-f697-4840-b8a6-165707e12345",
      "type": "SMS",
      "createdAt": "2023-09-19T04:55:50.723Z",
      "sentAt": "2023-09-19T04:55:50.723Z",
      "updatedAt": "2023-09-19T04:55:55.884Z",
      "direction": "INBOUND",
      "from": "+14159436397",
      "to": "+12061234567",
      "body": "Incoming message",
      "numSegments": 1,
      "campaignId": "U7fQ3123",
      "status": "DELIVERED"
    },
    {
      "id": "f7d258bd-f697-4840-b8a6-165707e12123",
      "type": "MMS",
      "createdAt": "2023-09-19T04:55:50.723Z",
      "sentAt": "2023-09-19T04:55:50.723Z",
      "updatedAt": "2023-09-19T04:55:55.884Z",
      "direction": "INBOUND",
      "from": "+14159436397",
      "to": "+12061234567",
      "body": "Another incoming message",
      "mediaUrls": ["https://example.com/image.jpg"],
      "numSegments": 1,
      "campaignId": "U7fQ3123",
      "metadata": {
        "customId": "123456789"
      },
      "status": "DELIVERED"
    },
    And so on...
  ]
}