API profile Client (direct) - Revision history

Maintenance script: API docs (generated from func=help)

2026-07-23T07:39:30Z

API docs (generated from func=help)

← Older revision		Revision as of 07:39, 23 July 2026
Line 19:		Line 19:
	== CDR (call detail) ==		== CDR (call detail) ==
	* [[API getcdr]] — Call Detail Records (CDR) for a period.		* [[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 ==		== CLIs / lines ==
	* [[API getclis]] — Lists CLIs (caller-line identities / DDIs) for the account.		* [[API getclis]] — Lists CLIs (caller-line identities / DDIs) for the account.

Maintenance script: API docs (generated from func=help)

2026-07-22T22:55:26Z

API docs (generated from func=help)

← Older revision		Revision as of 22:55, 22 July 2026
Line 1:		Line 1:
	''Profile '''Direct 7Kas client''' (root=0): 22 functions, own data only. Sees '''only its own selling price''' (accountcode column). Identity forced by the server.''		''Profile '''Direct 7Kas client''' (root=0): 24 functions, own data only. Sees '''only its own selling price''' (accountcode column). Identity forced by the server.''

	== Meta / discovery ==		== Meta / discovery ==

Maintenance script: API docs: add recording transcript/summary endpoints

2026-07-22T22:26:02Z

API docs: add recording transcript/summary endpoints

← Older revision		Revision as of 22:26, 22 July 2026
Line 1:		Line 1:
	''Profile '''Direct 7Kas client''' (root=0): 20 functions, own data only. Sees '''only its own selling price''' (accountcode column). Identity forced by the server.''		''Profile '''Direct 7Kas client''' (root=0): 22 functions, own data only. Sees '''only its own selling price''' (accountcode column). Identity forced by the server.''

	== Meta / discovery ==		== Meta / discovery ==

Maintenance script: API docs (generated from func=help)

2026-07-21T22:33:43Z

API docs (generated from func=help)

New page

''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 ==
* [[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.

----
[[API VoIP]] · [[API Console|▶ Try it live]]
[[Category:API profile]]