API profile Client (of operator)
Profile Client of an operator (root>0): 22 functions, own data only. Sees only its own selling price (root 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
- API getcallsbilling — Outgoing-call billing records for a period.
- API getcallsbillingcount — Row count for the given filter (smart pagination).
- API getcallsbillingtotal — Grand billing total for the caller's scope for the month.
- API getcallsbillingdetailtotal — Total over VOC detail rows matching the filter (with total_rows for pagination).
- API getcallsbillingcomis — Commission billing for a commissioner: aggregates the calls of the accounts assigned to the caller (accountcode_comis) and returns commission minutes/amount — never exposing costs.
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
- API getincomingcalls — Incoming-call records for a period.
- API getincomingcallscount — Row count for the given filter (smart pagination).
- API getincomingcallstotal — Grand incoming total for the caller's scope for the month.
- API getincomingcallsdetailtotal — Total over VIC detail rows matching the filter (with total_rows for pagination).
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
- API getpbxloclog — Tucloud PBX IVR/locution DTMF key-press log for a period.
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 helloworld — Health check / connectivity test.