TuCloudAPI getphonebooks: 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>q</code> || string || No || — || Optional name search (contains). | | <code>q</code> || string || No || — || Optional name search (contains). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
List the PBX phonebooks (address books) with contact counts. Tenant from (ukey, pbx).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getphonebooks&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. |
q |
string | No | — | Optional name search (contains). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getphonebooks&ukey=KEY&pbx=tucall
Response
{ok, rows:[{_id,name,description,color,icon,is_personal,contact_count}]}.
Back to TuCloudAPI