TuCloudAPI getcdr: Difference between revisions
API docs — add #39/#40 getcdr (via restapi) |
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 28: | Line 28: | ||
== Response == | == Response == | ||
{ok, rows:[{calldate,clid,clisrc,clidst,src,dst,billsec,lastapp,disposition}], record_count, has_more}. | {ok, rows:[{calldate,clid,clisrc,clidst,src,dst,billsec,lastapp,disposition,callfrom}], record_count, has_more}. callfrom = the engine call-direction bitmask (int): bit0=1 inbound-entrance, bit1=2 outbound-dial -> 0 Interna / 1 Entrante / 2 Saliente / 3 Entrante+Saliente (tránsito). | ||
---- | ---- | ||
Back to [[TuCloudAPI]] | Back to [[TuCloudAPI]] | ||
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | [[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | ||
Revision as of 14:14, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
List a period of this PBX's call detail records (Registro de llamadas), newest first. CDR is read from the 7kas restapi getcdr endpoint (server-to-server); tucloudapi adds the tucloud-pbx account filter. Metadata-only (no prices). Paginate with offset += limit until has_more is false. READ-ONLY.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getcdr&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server resolves this PBX's accountcode and reads only its own CDR via the restapi. |
year |
integer | Yes | — | Year (e.g. 2026). |
month |
integer | Yes | — | Month 1-12. |
day |
integer | No | — | Optional day 1-31 (blank = whole month). |
limit |
integer | No | 1000 |
Page size (1-1000). |
offset |
integer | No | 0 |
Pagination offset (advance by limit). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getcdr&ukey=KEY&pbx=tucall&year=2026&month=7
Response
{ok, rows:[{calldate,clid,clisrc,clidst,src,dst,billsec,lastapp,disposition,callfrom}], record_count, has_more}. callfrom = the engine call-direction bitmask (int): bit0=1 inbound-entrance, bit1=2 outbound-dial -> 0 Interna / 1 Entrante / 2 Saliente / 3 Entrante+Saliente (tránsito).
Back to TuCloudAPI