TuCloudAPI addphonebook
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
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
Create a phonebook. name is required + unique per tenant (-> conflict). color is a hex (#RRGGBB, default #3b82f6), icon a bootstrap-icons name (default bi-journal-bookmark), is_personal 0/1. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=addphonebook&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. |
name |
string | Yes | — | Phonebook name (required, unique per tenant, max 128). |
description |
string | No | — | Optional description (max 256). |
color |
string | No | #3b82f6 |
Hex color #RRGGBB. |
icon |
string | No | bi-journal-bookmark |
Bootstrap-icons name (max 32). |
is_personal |
integer | No | 0 |
1 = personal address book, 0 = shared. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addphonebook&ukey=KEY&pbx=tucall&name=Comercial
Response
{ok, phonebook:{...}} or {ok:false,conflict}.
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