TuCloudAPI getextension: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| 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 || — || Extension id (_id). | | <code>id</code> || integer || Yes || — || Extension 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
Get one extension with all editable fields (NO password). mode is REGISTRO (registered SIP) or TOEXT (sends to another extension). 404-style {ok:false,not_found} if not in the caller's PBX.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getextension&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 | — | Extension id (_id). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getextension&ukey=KEY&pbx=tucall&id=87365
Response
{ok, ext:{_id,num,name,ringtime,internalcli_id,teamsopt,teamsnum,peerid,pickupgroup,toext_id,is_trunk,mode,user,backupnum,backupmonpeer,music,tom,voicemail,email,incom_only_contacts,fwdshowcaller,fwd_cli,fwd,fwdnum,fwd_internal,fwdnum_internal,cli_id,recoutgoing,only_contacts,outs_id,nota}}.
Back to TuCloudAPI