TuCloudAPI getextensions
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
List the PBX extensions (safe display fields; NEVER the SIP password). Tenant resolved from (ukey, pbx). Each row carries hash_presence, the ready-made presence key of that extension: md5(peer name + account hash16), 32 lowercase hex, the very value the call engine sends on every PeerStatus. Subscribe to the presence service with <hash_presence>@ to watch the extension state; the state itself is NOT served here. Empty string means that extension is not published to presence.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getextensions&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. |
q |
string | No | — | Optional name/number search (contains). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getextensions&ukey=KEY&pbx=tucall
Response
{ok, rows:[EXT...]}. EXT={_id,num,name,teamsopt,teamsnum,peerid,toext_id,is_trunk,cli_id,music,tom,voicemail,ringtime,only_contacts,recoutgoing,hash_presence}.
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