Get delivery status

Returns the current delivery status of a write operation. Use this to poll for completion after sending a message, reaction, etc.

GET /v1/outbox

Get delivery status

cURL

curl --request GET \
  --url https://api.messages.dev/v1/outbox \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "line_id": "<string>",
  "status": "pending",
  "payload": {},
  "completed_at": 123,
  "error": "<string>",
  "attempts": 123,
  "max_attempts": 123,
  "created_at": 123,
  "request_id": "<string>"
}

Authorizations

Authorization · string · header · required

Use an API key as a bearer token: Authorization: Bearer sk_live_...

Each key has a set of scopes that gate which endpoints it can call: messages:read, messages:write, chats:read, lines:read, reactions:read, reactions:write, typing:read, typing:write, receipts:read, receipts:write, webhooks:read, webhooks:write, outbox:read, files:read, files:write. Keys can also be restricted to a subset of lines.

Query Parameters

id · string · required

Outbox item ID (prefixed with obx_)

Example:

"obx_abc123"

Response

200

application/json

Outbox item

id · string

Delivery ID (e.g. obx_abc123)

line_id · string

status · enum<string>

• pending: queued for delivery
• claimed: being processed
• sent: delivered successfully
• failed: delivery failed (see error field)

Available options: pending, claimed, sent, failed

payload · object

The original request payload

completed_at · number | null

Unix timestamp (ms) when delivery completed

error · string | null

Error message if delivery failed

attempts · number

Number of delivery attempts made

max_attempts · number

Maximum number of delivery attempts

created_at · number

Unix timestamp (ms) when the request was created

request_id · string