API profile SuperRoot
Profile SuperRoot (global administrator): full access, 44 functions. Sees provider cost, selling price and profit.
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 getcallsbillingtotalroot — Monthly billing total for one root/operator (TOC).
- API getcallsbillingcount — Row count for the given filter (smart pagination).
- API getcallsbillingtotal — Grand billing total for the caller's scope for the month.
- API getcallsbillingaccounttotal — Monthly billing total for one account.
- API getcallsbillingdetailtotal — Total over VOC detail rows matching the filter (with total_rows for pagination).
- API getcallsbillingalltotalroots — One billing-total row per root/operator (incl.
- 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>).
- API getservicesalltotalroots — One services-total row per root/operator (incl.
Incoming calls
- API getincomingcalls — Incoming-call records for a period.
- API getincomingcallstotalroot — Monthly incoming total for one root/operator (TIC).
- API getincomingcallscount — Row count for the given filter (smart pagination).
- API getincomingcallstotal — Grand incoming total for the caller's scope for the month.
- API getincomingcallsaccounttotal — Monthly incoming total for one account.
- API getincomingcallsdetailtotal — Total over VIC detail rows matching the filter (with total_rows for pagination).
- API getincomingcallsalltotalroots — One incoming-total row per root/operator (incl.
CDR (call detail)
- API getcdr — Call Detail Records (CDR) for a period.
Call recordings
- API getrecordings — Lists the caller's call recordings with availability flags (has_transcript, has_summary, has_audio).
- API getrecordingtranscript — Returns the transcription of one of the caller's recordings, with or without the summary (resumen).
- API getrecordingfile — Downloads the audio recording (stereo MP3) of one of the caller's calls.
- API getrecordingcertification — Downloads the integrity/veracity certification file (.txt) of one of the caller's recordings: file, user, date, time, uniqueid, src, dst and the SHA-512 hash (matches voip_callrecord.recordhash).
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 getaccountcodeid — Lists (id, accountcode) pairs of the accounts under the caller.
- API getaccountcodedata — Returns full account profile rows (view_voip_users_api) for the caller's accounts.
- API lockaccountcode — Blocks (locks) an account (blocked=SI).
- API unlockaccountcode — Unblocks (unlocks) an account (blocked=NO).
- API addaccountcode — Creates a new account (client) under the caller.
- API getcredit — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
WireGuard / VPN
- API getwgpeers — Lists WireGuard peers of a server (SSIP-transparent union of SSIP + VPN pairs).
- API setwgstatus — Enables/disables a WireGuard peer.
- API registerwgserver — Registers/updates a WireGuard server (public key, listen port, endpoint).
- API registerwgdevice — Registers an SSIP device's WireGuard public key (keyed by device MAC).
- 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.
Administration
- API SetDebugLevel — Sets the runtime debug/log verbosity level.
- API ReloadUsersKeys — Hot-reloads the API keys from the database without restarting the service.
- API resetinternalkey — Regenerates the non-showable internal API key for an account.
- API getpoolstats — Connection-pool statistics for the 4 PostgreSQL pools (busy/free/waiters, hits/misses, utilization).
Diagnostics
- API helloworld — Health check / connectivity test.