TuCloudAPI getphonebook
TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.
Description
Get one phonebook plus its contacts. 404-style not_found if not in the caller's PBX.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getphonebook&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. |
id |
integer | Yes | — | Phonebook id (_id). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getphonebook&ukey=KEY&pbx=tucall&id=1
Response
{ok, phonebook:{_id,name,description,color,icon,is_personal}, contacts:[{_id,display_name,phone,phone2,email,company,notes,speed_dial}]}.
Back to TuCloudAPI