TuCloudAPI getaudio: Difference between revisions
+ getaudio |
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}} | |||
== Description == | == 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 == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=getaudio&ukey=YOUR_KEY&pbx=PBX_NAME | |||
Requires the <code>ukey</code> parameter. | GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope. | ||
== Parameters == | == Parameters == | ||
| Line 12: | Line 14: | ||
! 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. | ||
| Line 22: | Line 24: | ||
== Response == | == Response == | ||
{ok:true, mime:"audio/wav", name, data:<base64>}. Play as a data: URL. Errors: {ok:false,code,message} (missing_pbx | {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 <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function. | |||
---- | ---- | ||
Back to [[TuCloudAPI]] | Back to [[TuCloudAPI]] | ||
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | [[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | ||
Latest revision as of 21:16, 8 October 2026
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