API VoIP

ℹ New here? Jump to the self-discovery endpoint or open the live ▶ API Console to try any call with your own key.

Overview

The 7Kas VoIP REST API exposes query and management functions over CDR, billing, incoming calls, call recordings (audio/transcripts/certification), accounts, pay-per-use services, CLIs, Tucloud PBX and WireGuard. HTTPS, GET, JSON.

Self-discovery (start here)

The API documents itself, filtered by your role:

…/7Kas?func=help&ukey=YOUR_KEY              (full catalogue for your profile)
…/7Kas?func=help&ukey=YOUR_KEY&name=getcdr  (one function)

See API help. This wiki is generated from that same source, so it never drifts.

Authentication

Every call needs an API key (parameter ukey, max 40) issued by 7Kas. Clients have their identity parameters (accountcode/accountcodeid) forced server-side to their own values.

Response format

Always HTTP 200; on any error (bad/missing func or ukey, validation error, unknown function, task-limit exceeded) the body is {}. Data functions use FillRecords2JSON:

{ "RecordCount": N, "fields": [...], "1": [...], "2": [...] }

Empty result ⇒ {}. SQL NULL ⇒ JSON null.

Limits

Up to 10,000 rows/request from the SHM cache; 1,000 from PostgreSQL. Paginate with limit/offset.

Catalogue by profile

• API profile SuperRoot — 44 functions (everything)
• API profile Operator — 37 functions
• API profile Client (of operator) — 24 functions (client of an operator, root>0)
• API profile Client (direct) — 24 functions (direct 7Kas client, root=0)

Try it

Open the API Console: paste your ukey, pick a function, fill parameters and run a real (read-only-safe) call from your browser.