API reference

Carrier messages

List, inspect, and reconcile SMS messages across the carrier.

Message resource

Messagejson

{
  "data": {
    "id": "SM…",
    "type": "message",
    "attributes": {
      "account_id": "AC…",
      "to": "+2348000000001",
      "from": "+2348000000002",
      "body": "Your code is 1234",
      "status": "delivered",
      "price": "-4.00",
      "sent_at": "…",
      "created_at": "…"
    }
  }
}

List messages

GET/carrier/v1/messages

Return messages across the carrier, filterable.

Parameter	Type	Description
`filter[account_id]` optional	`string`	Restrict to an account.
`filter[to]` optional	`string`	Filter by destination.
`filter[from]` optional	`string`	Filter by sender.
`filter[status]` optional	`string`	Filter by status.
`filter[message_type]` optional	`string`	Filter by type (e.g. sms).
`filter[created_at]` optional	`time`	Filter by creation time.
`page` optional	`integer`	0-indexed page.
`per_page` optional	`integer`	Records per page.

Fetch a message

GET/carrier/v1/messages/{id}

Return a single message.

Update a message

PATCH/carrier/v1/messages/{id}

Update billing data on a message (e.g. set a manual price).

Parameter	Type	Description
`data.type` required	`string`	`message`
`data.id` required	`string`	The message ID.
`data.attributes.price` optional	`string`	Override the message price.