@telequick/admin-sdk is a typed TypeScript client for the same administration API the TeleQuick console runs on. Everything you can do in the console — agents, trunks, call records, recordings, analytics, webhooks — is callable, with input and output types generated from the live server surface. Build your own dashboard or backoffice on it; the console itself consumes this exact package, so the contract cannot drift.

Install

(The artifacts origin is shared across brands — the same origin that serves the prebuilt binaries.)

Authenticate

Mint an API key in the console under Settings → API keys, choosing the narrowest scopes your integration needs. A key:
  • acts as the user who minted it, never exceeding what that user can do right now — demote or remove them and the key shrinks or stops with them;
  • is pinned to one organization — naming another org is refused, not obeyed;
  • carries narrow mcp:<domain>:<action> scopes — a key minted to read call records cannot create a trunk.

Call history, recordings, analytics

For live call lifecycle events (ringing, connected, ended) subscribe to webhooks instead of polling — the CDR surface is the historical record, webhooks are the real-time feed.

Voice agents

Notes

  • Operations take orgId in their input. The client fills it in at runtime when omitted, but the types ask for it — pass it explicitly.
  • Errors are TRPCClientError. FORBIDDEN naming a scope means the key is real but was minted without that authority — mint a purpose-specific key rather than widening an existing one.
  • The account routes (sessions, passwords, identities) are excluded from the key-reachable surface by construction.