TuCloudAPI addlocution: 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 32). | | <code>name</code> || string || Yes || — || Display name (required, max 32). | ||
Latest revision as of 14:30, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Create a locution / IVR. loc (the *40<loc> number, unique per tenant) auto-assigns to max+1 when 0. name required. waitext 1 = allow direct-dial extension. Each digit route validated in-tenant. NOTE: this does NOT create the audio file (upload is delegated to a media-server backend). Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addlocution&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 32). |
loc |
integer | No | 0 |
Locution number 1-999 (0 = auto max+1). |
waitext |
integer | No | 1 |
1 = allow direct-dial extension, 0 = no. |
ziro |
integer | No | 0 |
DTMF 0 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
one |
integer | No | 0 |
DTMF 1 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
two |
integer | No | 0 |
DTMF 2 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
three |
integer | No | 0 |
DTMF 3 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
four |
integer | No | 0 |
DTMF 4 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
five |
integer | No | 0 |
DTMF 5 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
six |
integer | No | 0 |
DTMF 6 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
seven |
integer | No | 0 |
DTMF 7 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
eight |
integer | No | 0 |
DTMF 8 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
nine |
integer | No | 0 |
DTMF 9 -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
asterisk |
integer | No | 0 |
DTMF * -> Route _id to jump to when this DTMF key is pressed (0/blank = no branch); validated in-tenant. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addlocution&ukey=KEY&pbx=tucall&name=Bienvenida&one=197
Response
{ok, locution:{...}} or {ok:false,conflict}.
Back to TuCloudAPI