Skip to main content
The Messages API is a versioned HTTP API for sending and receiving traffic on your Comms line.

Base URL

All routes in this reference live under:

Authentication

Keys are minted in the dashboard: Messages API. See Authentication for scopes, rotation, and security rules.

Conventions

TopicRule
Content typeapplication/json on bodies
Phone numbersE.164 (+12125550147)
IdempotencyHeader Idempotency-Key on outbound sends
Errors{ "error": "…" } JSON
TimeISO-8601 where timestamps appear

Endpoint map

Messages

MethodPathScopeDocs
POST/api/v1/comms/messagescomms_sendSend
GET/api/v1/comms/messagescomms_readList

Conversations

MethodPathScopeDocs
GET/api/v1/comms/conversationscomms_readList

Contacts

MethodPathScopeDocs
GET/api/v1/comms/contactscomms_readList
POST/api/v1/comms/contactswrite*Upsert
*Contact upsert currently expects the broader write scope when present on the key.

Webhooks

MethodPathScopeDocs
GET/api/v1/comms/webhookscomms_webhooksList
POST/api/v1/comms/webhookscomms_webhooksCreate

Events

MethodPathScopeDocs
GET/api/v1/comms/eventscomms_readList

Rate limits

See Errors & rate limits. Defaults are roughly 100 requests/min globally and 60 sends/min per caller.

SDKs

There is no required SDK. Use any HTTP client with a Bearer token. The quickstart shows cURL, Node, and Python.