API reference

Retrieve a message

One message as it is now: status, price, route and each part's delivery receipt.

GEThttps://api.siellabs.com/v1/messages/{id}

Path parameters#

idstringRequired

The message's id, as returned when you sent it and in its webhooks.

Example#

curl https://api.siellabs.com/v1/messages/36f6090d-93a6-46ec-8cd9-73ef8e6797c7 \
  -H "Authorization: Bearer $SMSGW_API_KEY"

Response#

200 OK with the message, including what only this endpoint shows: its parts with each part's delivery receipt, and its short links with their clicks. While it's being sent its status reads sending, and while it waits to be tried again error_code is RETRYING.

200 OK

{
  "id": "01a18c17-566b-7b3d-9f42-6a8e0d51c2b7",
  "to": "+447700900123",
  "from": "YourBrand",
  "body": "Your order #4821 has shipped: https://api.siellabs.com/r/aB3dE9x",
  "links": [
    {
      "code": "aB3dE9x",
      "short_url": "https://api.siellabs.com/r/aB3dE9x",
      "url": "https://shop.example.com/o/4821",
      "clicks": 2,
      "first_click_at": "2026-10-30T09:17:40.112Z",
      "last_click_at": "2026-10-30T11:02:03.9Z"
    }
  ],
  "status": "delivered",
  "country": "GB",
  "network": "Vodafone UK",
  "encoding": "gsm7",
  "segments": 1,
  "price_micros": 30000,
  "campaign_id": null,
  "error_code": null,
  "error_message": null,
  "attempts": 1,
  "created_at": "2026-10-30T09:15:02.123456Z",
  "sent_at": "2026-10-30T09:15:02.871Z",
  "done_at": "2026-10-30T09:15:09.004211Z",
  "parts": [
    {
      "seq": 1,
      "units": 67,
      "limit": 160,
      "status": "delivered",
      "smsc_id": "3b9aca7b",
      "receipt_stat": "DELIVRD",
      "receipt_err": "000",
      "submitted_at": "2026-10-30T09:15:02.85Z",
      "done_at": "2026-10-30T09:15:09.004211Z"
    }
  ]
}

An id that isn't yours, or isn't an id at all, gets 404 not_found.