API getcdr - Revision history

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

2026-08-03T10:31:12Z

API docs (generated from func=help)

← Older revision		Revision as of 10:31, 3 August 2026
Line 30:		Line 30:

	== Response ==		== Response ==
	FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}. Columns: calldate, clisrc, clidst, clid, src, dst, billsec, lastapp, disposition, uniqueid, channel, dstchannel, callfrom. callfrom = ~~raw~~ call-direction code ~~set by the PBX~~ (~~integer;~~ 1 = incoming/~~Entrante~~). ~~The portal maps~~ the ~~code to its direction label (Interna/Entrante/Saliente)~~.		FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}. Columns: calldate, clisrc, clidst, clid, src, dst, billsec, lastapp, disposition, uniqueid, channel, dstchannel, callfrom. callfrom = call-direction code (0 = undetermined, 1 = incoming/entrante, 2 = outgoing/saliente, 3 = incoming re-launched as outgoing). Source of truth: the COMMENT on tucall.voip_cdr.callfrom.

	== Column visibility by profile ==		== Column visibility by profile ==

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

2026-08-03T10:19:10Z

API docs (generated from func=help)

← Older revision		Revision as of 10:19, 3 August 2026
Line 30:		Line 30:

	== Response ==		== Response ==
	FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}.		FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}. Columns: calldate, clisrc, clidst, clid, src, dst, billsec, lastapp, disposition, uniqueid, channel, dstchannel, callfrom. callfrom = raw call-direction code set by the PBX (integer; 1 = incoming/Entrante). The portal maps the code to its direction label (Interna/Entrante/Saliente).

	== Column visibility by profile ==		== Column visibility by profile ==

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

2026-07-21T22:33:31Z

API docs (generated from func=help)

New page

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

== Description ==
Call Detail Records (CDR) for a period. One function serves all roles (CDR has no pricing columns). Clients see only their own account (accountcodeid is forced); operators their scope; SuperRoot everything. Served from SHM cache with PostgreSQL fallback.

== Call ==
GET …/7Kas?func=getcdr&ukey=YOUR_KEY&…
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year of the records (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>day</code> || integer || No || — || Filter by day of month (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). <small>(only valid together with day)</small>
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id. Ignored/forced to the caller's own for clients.
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows. SHM fast-path up to 10000, PostgreSQL fallback up to 1000.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcdr&ukey=KEY&year=2026&month=7&limit=100</nowiki>

== Response ==
FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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)]]
[[Category:API SuperRoot]][[Category:API Operator]][[Category:API Client]][[Category:API function]]