TuCloudAPI updatephonebook: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <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>id</code> || integer || Yes || — || Phonebook id (_id). | | <code>id</code> || integer || Yes || — || Phonebook id (_id). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Edit a phonebook. 404 if not in the caller's PBX. Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=updatephonebook&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. |
id |
integer | Yes | — | Phonebook id (_id). |
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, 0 = shared. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=updatephonebook&ukey=KEY&pbx=tucall&id=1&name=Comercial
Response
{ok, phonebook:{...}}.
Back to TuCloudAPI