TuCloudAPI getaudio
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.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
https://tucloudapi.7kas.com:9087/tucloud?func=getaudio&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
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|forbidden|invalid_param|not_found|db_error).
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI