Jump to content

API getservices: 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 42: Line 42:


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

Detail of pay-per-use services (dtype=SERVICIOS, e.g. STT osttrc), decoupled from calls. Optional service=<prefix> narrows to one service. Same role columns and SHM+PostgreSQL behaviour as getcallsbilling (voc).

Call

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

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
year integer Yes — Year.
month integer Yes — Month, 1-12.
service string No — Service prefix (e.g. osttrc). Omit for all services. (max 20)
accountcode string No — Filter by account (non-clients). Forced to own for clients. (max 20)
day integer No — Filter by day (1-31).
hour integer No — Filter by hour. (requires day)
limit integer No 100 Max rows (SHM up to 10000, PostgreSQL up to 1000).
offset integer No 0 Pagination offset.

Example

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

Response

FillRecords2JSON records; every row has dtype=SERVICIOS and prefix=the service.

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 · ▶ Try it live · Profiles: API profile Operator, API profile Client (of operator), API profile Client (direct)