Jump to content

API getpbxloclog: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help)
 
API docs regenerated from func=help (operator catalogue)
 
Line 1: Line 1:
''7Kas VoIP REST API function. Available to: '''SuperRoot, Operator, Client'''.''
''7Kas VoIP REST API function. Available to: '''Operator, Client'''.''


== Description ==
== Description ==
Line 45: Line 45:


----
----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile SuperRoot]], [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
[[Category:API SuperRoot]][[Category:API Operator]][[Category:API Client]][[Category:API function]]
[[Category:API Operator]][[Category:API Client]][[Category:API function]]

Latest revision as of 13:47, 5 November 2026

7Kas VoIP REST API function. Available to: Operator, Client.

Description

Tucloud PBX IVR/locution DTMF key-press log for a period. Role-resolved (clients see only their own account; operators their scope; SuperRoot all). Single SQL function; unset filters default to NULL server-side.

Call

GET  …/7Kas?func=getpbxloclog&ukey=YOUR_KEY&…

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
year integer Yes — Year (e.g. 2026).
month integer Yes — Month, 1-12.
day integer No — Filter by day of month (1-31).
hour integer No — Filter by hour (0-23). (only valid together with day)
accountcodeid integer No — Filter by account id (non-clients). Forced to own for clients.
tucloudpbx_id integer No — Filter by virtual PBX id.
loc_id integer No — Filter by locution/IVR id.
pbxname string No — Filter by PBX name. (max length 32)
pressed string No — Filter by DTMF key(s) pressed. (max length 80)
src string No — Filter by source number. (max length 80)
dst string No — Filter by destination number. (max length 80)
limit integer No 100 Max rows (PostgreSQL up to 1000).
offset integer No 0 Pagination offset.

Example

https://api.7kas.com:9080/7Kas?func=getpbxloclog&ukey=KEY&year=2026&month=7&limit=100

Response

FillRecords2JSON records.


Back to API VoIP · ▶ Try it live · Profiles: API profile Operator, API profile Client (of operator), API profile Client (direct)