Jump to content

API getclis

From Wiki 7Kas

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

Description

Lists CLIs (caller-line identities / DDIs) for the account. Clients see only their own account's CLIs (accountcode is forced); operators and SuperRoot see their scope.

Call

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

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
accountcode string No Filter by account code. Forced to the caller's own for clients. (max length 20)
active string No Filter by active flag. (max length 2)
route string No Filter by route. (max length 32)
type string No Filter by CLI type. (max length 2)
limit integer No 1000 Maximum rows to return (capped at 1000).
offset integer No 0 Pagination offset.

Example

https://api.7kas.com:9080/7Kas?func=getclis&ukey=KEY&limit=100

Response

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


Back to API VoIP · ▶ Try it live · Profiles: API profile SuperRoot, API profile Operator, API profile Client (of operator), API profile Client (direct)