TuCloudAPI getlocution
TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.
Description
Get one locution with its DTMF digit->route map (+ resolved route names), has_audio and audio_url. 404-style not_found if not in the caller's PBX.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getlocution&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. |
id |
integer | Yes | — | Locution id (_id). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getlocution&ukey=KEY&pbx=tucall&id=902
Response
{ok, locution:{_id,loc,name,waitext,digits:{ziro..asterisk},digit_names:{...},has_audio,audio_url}}.
Back to TuCloudAPI