TuCloudAPI getaudio: 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>kind</code> || string || Yes || — || locution | music. | | <code>kind</code> || string || Yes || — || locution | music. | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
General-purpose audio file server (not only for the simulator): serve a locution or music-on-hold audio file base64-encoded (audio/wav) — for hover-preview, players, downloads, etc. anywhere in the portal. Read-only and strictly tenant-scoped: pass pbx + kind + the entity id; the server resolves the row IN THIS PBX and builds the path from the tenant's OWN root+pbxid (client-supplied paths are never accepted), so a ukey can only read its own PBX's audio.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getaudio&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. |
kind |
string | Yes | — | music. |
id |
integer | Yes | — | Locution _id (kind=locution) or music _id (kind=music), from the simulatecall audio descriptor / getappactions. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getaudio&ukey=KEY&pbx=tucall&kind=locution&id=1239
Response
{ok:true, mime:"audio/wav", name, data:<base64>}. Play as a data: URL. Errors: {ok:false,code,message} (missing_pbx|unknown_pbx|forbidden|invalid_param|not_found|db_error).
Back to TuCloudAPI