Maintenance script: API docs regenerated from func=help (operator catalogue)

2026-11-05T13:47:32Z

API docs regenerated from func=help (operator catalogue)

← Older revision		Revision as of 13:47, 5 November 2026
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 48:		Line 48:

	----		----
	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]]

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 ==
Outgoing-call billing records for a period. model=voc (detailed calls, supports day/hour and server-side search) or toc (per-account totals). Role-based columns: clients see only their own account (accountcode forced) and their price; operators their scope + profit; SuperRoot everything incl. provider costs. SHM fast-path + PostgreSQL fallback.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>model</code> || string || No || <code>voc</code> || voc = detailed calls; toc = totals. (valid: voc|toc (case-insensitive))
|-
| <code>accountcode</code> || string || No || — || Filter by account code (non-clients). Forced to own for clients. (max 20)
|-
| <code>day</code> || integer || No || — || Filter by day (1-31). (model=voc only)
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). (model=voc only, requires day)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows. SHM up to 10000, PostgreSQL up to 1000.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|-
| <code>search</code> || string || No || — || Server-side search pattern. (max 40)
|-
| <code>search_fields</code> || string || No || — || Comma-separated fields (whitelist: dst, cid_num, cid_name, cli_billing, dial_cid_num, accountcode, prefix, dtype, context, tariff, fromuri). (max 200)
|-
| <code>search_mode</code> || string || No || <code>contains</code> || Match mode. (prefix|suffix|contains|exact)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbilling&ukey=KEY&year=2026&month=7&model=voc&limit=100</nowiki>

== Response ==
FillRecords2JSON records (columns depend on role).

== 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]]

API getcallsbilling - Revision history

Maintenance script: API docs regenerated from func=help (operator catalogue)

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