TuCloudAPI getcdr
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.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
https://tucloudapi.7kas.com:9087/tucloud?func=getcdr&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX 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).
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI