API reference
Base URL: https://api.account.telebroad.com/api/public/v1 — every endpoint takes an API key or an OAuth token as Authorization: Bearer ….
These pages are generated from the OpenAPI spec, so they cannot drift from what the API does.
SMS
Send a text message from one of the account's numbers, and discover which numbers those are. Sending is billed — see the SMS billing concept page.
| Endpoint | Scope | Purpose |
|---|---|---|
GET /sms/lines | sms:read | List the numbers you can send from |
POST /sms/messages | sms:send | Send a text message |
GET /sms/unread | messages:read | Unread counts |
POST /sms/lines/{line}/read | messages:write | Mark a whole line read |
GET /sms/lines/{line}/blocked | sms:read | List blocked senders |
POST /sms/lines/{line}/blocked | sms:write | Block a sender |
GET /sms/lines/{line}/blocked/{number} | sms:read | Check whether a number is blocked |
DELETE /sms/lines/{line}/blocked/{number} | sms:write | Unblock a sender |
GET /sms/lines/{line}/scheduled | sms:read | List scheduled messages |
POST /sms/lines/{line}/scheduled | sms:send | Schedule a message |
DELETE /sms/lines/{line}/scheduled/{id} | sms:write | Cancel a scheduled message |
GET /sms/templates | sms:read | List saved replies |
POST /sms/templates | sms:write | Save a reply |
PUT /sms/templates/{id} | sms:write | Edit a saved reply |
DELETE /sms/templates/{id} | sms:write | Delete a saved reply |
GET /sms/drafts/{draftId} | sms:read | Read a draft |
PUT /sms/drafts/{draftId} | sms:write | Save a draft |
DELETE /sms/drafts/{draftId} | sms:write | Discard a draft |
Conversations
A text thread's state. A conversation has no id: it is the pair (one of your numbers, the other party's number).
| Endpoint | Scope | Purpose |
|---|---|---|
POST /sms/conversations/{line}/{number}/resolve | sms:write | Mark a conversation handled |
GET /sms/conversations | messages:read | List conversations (the inbox) |
GET /sms/conversations/{line}/{number} | messages:read | Read a conversation's messages |
DELETE /sms/conversations/{line}/{number} | messages:write | Delete a conversation |
GET /sms/conversations/{line}/{number}/messages/{id} | messages:read | Read the page containing a message |
DELETE /sms/conversations/{line}/{number}/messages/{id} | messages:write | Delete one message |
POST /sms/conversations/{line}/{number}/read | messages:write | Mark messages read or unread |
POST /sms/conversations/{line}/{number}/reopen | sms:write | Reopen a resolved conversation |
POST /sms/conversations/{line}/{number}/assign | sms:write | Assign a conversation to a user |
Users
The account's users — who works here, and how to reach them.
| Endpoint | Scope | Purpose |
|---|---|---|
GET /users | users:read | List the account's users |
Calls
Call history, one call's journey, its recordings and its transcripts. A call with transfers is ONE call with several legs — and several recordings and transcripts.
| Endpoint | Scope | Purpose |
|---|---|---|
POST /calls/search | reports:read | Search call history |
GET /calls/{callid} | reports:read | Get one call with its legs |
GET /calls/{callid}/transcripts | recordings:read | Get a call's transcripts |
GET /calls/{callid}/recordings | recordings:read | List a call's recordings |
GET /calls/{callid}/recordings/{uniqueid} | recordings:read | Get one recorded leg |
Webhooks
Subscriptions to account events. This is the configuration API; the payloads that get delivered to your endpoint are documented in the Webhooks guide.
| Endpoint | Scope | Purpose |
|---|---|---|
GET /webhooks | webhooks:read | List webhook subscriptions |
POST /webhooks | webhooks:write | Create a webhook subscription |
GET /webhooks/types | webhooks:read | List the valid event types |
GET /webhooks/{id} | webhooks:read | Get one subscription |
PUT /webhooks/{id} | webhooks:write | Update a subscription (merge — identical to PATCH) |
PATCH /webhooks/{id} | webhooks:write | Update a subscription (merge) |
DELETE /webhooks/{id} | webhooks:write | Delete a subscription |
POST /webhooks/{id}/enable | webhooks:write | Start delivering to a subscription |
POST /webhooks/{id}/disable | webhooks:write | Stop delivering to a subscription |