v51

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

Message

Get a message by ID

Retrieves the message of the given ID.

get/messages/{id}

Path parameters

idstring required

The ID of the message.

Response

The message details.

idstring uuid

Unique identifier for the message.

customer_idstring uuid

Unique identifier for the customer. Returned from the GET /customers response.

type'sms'

Type of the message.

textstring

The text delivered in the body of the message.

direction'outbound' | 'inbound'

Direction of the message.

tm_createstring date-time

Timestamp when the message was created.

tm_updatestring date-time

Timestamp when the message was last updated.

tm_deletestring date-time

Timestamp when the message was deleted.

Example response

{
  "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"
}