TuCloudAPI addphonebook: Difference between revisions

Latest revision as of 14:30, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

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

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addphonebook&ukey=YOUR_KEY

Requires the ukey parameter.

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}.

Back to TuCloudAPI

@@ Line 12: / Line 12: @@
 ! Parameter !! Type !! Required !! Default !! Meaning
 |-
-| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
+| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
 |-
 | <code>name</code> || string || Yes || — || Phonebook name (required, unique per tenant, max 128).