v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Message

List all messages

Retrieves a list of messages for the given customer.

get/messages

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

A list of messages.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "type": "sms",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "targets": [
        {
          "destination": {
            "type": "tel",
            "target": "+14155551234",
            "target_name": "John Smith",
            "name": "Main Office",
            "detail": "Primary contact number"
          },
          "status": "delivered",
          "parts": 1,
          "tm_update": "2026-01-15T09:30:00.000000Z"
        }
      ],
      "text": "Your appointment is confirmed for tomorrow at 2 PM.",
      "direction": "outbound",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}