TuCloudAPI addphonebookcontact
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
ℹ Requires the
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Add a contact to a phonebook. book = the phonebook _id (validated in-tenant). Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=addphonebookcontact&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX 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:[{...}]}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI