TuCloudAPI getcontacts
TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.
Description
List the PBX contacts (address book). Each contact feeds caller-name (CNAM) lookup, the **<prefix> speed-dial, and the only-contacts extension allow-lists. Tenant from (ukey, pbx).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getcontacts&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. |
q |
string | No | — | Optional name/phone/prefix search (contains). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getcontacts&ukey=KEY&pbx=tucall
Response
{ok, rows:[{_id,cname,phone,prefix}]}.
Back to TuCloudAPI