TuCloudAPI addphonebookcontact
TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.
Description
Add a contact to a phonebook. book = the phonebook _id (validated in-tenant). Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addphonebookcontact&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. |
book |
integer | Yes | — | Parent phonebook _id. |
display_name |
string | Yes | — | Contact name (required, max 128). |
phone |
string | Yes | — | Phone number (required, digits/+, max 64). |
phone2 |
string | No | — | Second phone. |
email |
string | No | — | Email (max 128). |
company |
string | No | — | Company (max 128). |
notes |
string | No | — | Notes (max 512). |
speed_dial |
string | No | — | Speed-dial short code (digits, max 5). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addphonebookcontact&ukey=KEY&pbx=tucall&book=1&display_name=Juan&phone=600111222
Response
{ok, contacts:[{...}]}.
Back to TuCloudAPI