Skip to main content

Telebroad Developer Docs

Build on the Telebroad platform. The API lets your application manage account resources on a user's behalf over a standard REST interface.

  • Base URL: https://api.account.telebroad.com/api/public/v1
  • Auth: OAuth 2.1 — authorization code + PKCE (public clients, no secret)
  • Format: JSON, wrapped as { "data": … }

Where to start

  1. Authentication (OAuth 2.1) — register your app, send the user through consent, and get an access token.
  2. Webhooks API — subscribe to account events.
  3. SMS — list the account's texting numbers, and send from one. Sending is billed per segment (or once, for a group thread); the response tells you what it cost.
  4. Users — the account's users: names, emails, extensions. This is what turns a user id or an extension into a person.
  5. Call recordings — playable links to the audio of a recorded call.

More API references are added here as the platform grows.

Response format

Every endpoint is under /api/public/v1. Success is wrapped as { "data": … }; errors are { "error": { "type", "message" } }. Branch on error.type — it is stable — never on error.message.

The OAuth endpoints are the one thing you should not hardcode: read them from the discovery document, which is authoritative.