Jump to content

API profile Client (direct)

From Wiki 7Kas
Revision as of 22:33, 21 July 2026 by Maintenance script (talk | contribs) (API docs (generated from func=help))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Profile Direct 7Kas client (root=0): 20 functions, own data only. Sees only its own selling price (accountcode column). Identity forced by the server.

Meta / discovery

  • API help — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.

Outgoing call billing

Pay-per-use services

  • API getservices — Detail of pay-per-use services (dtype=SERVICIOS, e.g.
  • API getservicestotal — Aggregate total of pay-per-use services for the period (all services, or one via service=<prefix>).

Incoming calls

CDR (call detail)

  • API getcdr — Call Detail Records (CDR) for a period.

CLIs / lines

  • API getclis — Lists CLIs (caller-line identities / DDIs) for the account.

Tucloud PBX

Account management

  • API getcredit — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).

WireGuard / VPN

  • API getwgconfig — Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).
  • API registervpnwgdevice — Registers a non-SSIP VPN WireGuard device, authenticated by (host, password) of the VPN pair (voip_vtun).
  • API getvpnwgconfig — Returns the WireGuard config for a non-SSIP VPN device, authenticated by (host, password) of the VPN pair.

Diagnostics


API VoIP · ▶ Try it live