API getincomingcalls
7Kas VoIP REST API function. Available to: SuperRoot, Operator, Client.
Description
Incoming-call records for a period. model=vic (detail, supports day/hour) or tic (totals). Role-based columns: clients see only their own account (accountcodeid forced) and their selling price; operators their scope; SuperRoot everything incl. provider costs. SHM fast-path + PostgreSQL fallback. Server-side search on src/dst.
Call
GET …/7Kas?func=getincomingcalls&ukey=YOUR_KEY&…
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
year |
integer | Yes | — | Year (e.g. 2026). |
month |
integer | Yes | — | Month, 1-12. |
model |
string | No | vic |
tic (case-insensitive)) |
accountcodeid |
integer | No | — | Filter by account id (non-clients). Forced to own for clients. |
day |
integer | No | — | Filter by day (1-31). (model=vic only) |
hour |
integer | No | — | Filter by hour (0-23). (model=vic only, requires day) |
limit |
integer | No | 100 |
Max rows. SHM up to 10000, PostgreSQL up to 1000. |
offset |
integer | No | 0 |
Pagination offset. |
search |
string | No | — | Server-side search pattern. (max 40) |
search_fields |
string | No | — | Comma-separated fields to search (whitelist: src, dst). (max 200) |
search_mode |
string | No | contains |
suffix|contains|exact) |
Example
https://api.7kas.com:9080/7Kas?func=getincomingcalls&ukey=KEY&year=2026&month=7&model=vic&limit=100
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 · ▶ Try it live · Profiles: API profile SuperRoot, API profile Operator, API profile Client (of operator), API profile Client (direct)