TuCloudAPI addextension: 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>name</code> || string || Yes || — || Display name (required, max 64). | | <code>name</code> || string || Yes || — || Display name (required, max 64). | ||
Latest revision as of 14:30, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Create an extension. The server derives num (max+1, else 200; 112->113), the SIP user (pbxname+num) and — unless password is supplied — a random SIP password; root/tucloudpbx_id come from the tenant. Every lookup id is validated to belong to this PBX. Unique (pbx,num) -> {ok:false,conflict}. The SIP peer + voicemail are created automatically by the DB trigger. Requires a non-readonly ukey. Password is NOT returned (use getextqr).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addextension&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 | — | Display name (required, max 64). |
cli_id |
integer | Yes | — | Outgoing caller ID id (required; from getextlookups.clis). |
ringtime |
integer | No | 0 |
Ring seconds: 0 (PBX default) or 5-50. |
internalcli_id |
integer | No | 0 |
Internal/mobile CLI id (0 = none). |
teamsopt |
string | No | S |
T=Teams, S=VoIP, TS=both. |
teamsnum |
string | No | — | Teams number (digits only, max 64; unique). |
pickupgroup |
integer | No | 0 |
Pickup group 0-999. |
toext_id |
integer | No | 0 |
Send-to extension id (0 = registered SIP mode). |
password |
string | No | — | Explicit SIP password (blank = auto-generate). |
backupnum |
string | No | — | Backup number (digits and +, max 64). |
backupmonpeer |
string | No | — | Extension num to monitor for backup. |
music |
integer | No | 0 |
Music-on-hold id (0 = default). |
tom |
integer | No | 0 |
0=tone, 1=music. |
voicemail |
integer | No | 0 |
1=enable voicemail. |
email |
string | No | — | Voicemail/notification email. |
incom_only_contacts |
integer | No | 0 |
1=accept only contacts/extensions. |
fwdshowcaller |
integer | No | 0 |
1=show original caller on forward. |
fwd_cli |
integer | No | 0 |
External-forward caller-ID (0=Si,1=No; inverse). |
fwd |
integer | No | 0 |
External forward: 0=off,1=all,2=busy,3=noanswer,4=busy/noanswer. |
fwdnum |
string | No | — | External forward destination. |
fwd_internal |
integer | No | 0 |
Internal forward (same 0-4 scale). |
fwdnum_internal |
string | No | — | Internal forward destination. |
recoutgoing |
integer | No | 0 |
1=record outgoing calls. |
only_contacts |
integer | No | 0 |
1=restrict outbound to contacts. |
outs_id |
integer | No | 0 |
Outgoing service id (0 = none). |
nota |
string | No | — | Free note (max 256). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addextension&ukey=KEY&pbx=tucall&name=Recepcion&cli_id=81324
Response
{ok, ext:{...}} (no password).
Back to TuCloudAPI