TuCloudAPI getaudio - Revision history

Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

2026-08-03T14:31:08Z

TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

← Older revision		Revision as of 14:31, 3 August 2026
Line 12:		Line 12:
	! Parameter !! Type !! Required !! Default !! Meaning		! Parameter !! Type !! Required !! Default !! Meaning
	\|-		\|-
	\| <code>pbx</code> \|\| string \|\| Yes \|\| — \|\| ~~TuCloud PBX~~ NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.		\| <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.

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

2026-08-03T14:14:10Z

TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

← Older revision		Revision as of 14:14, 3 August 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage ~~tucloud~~ (PBX) ~~services~~. Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

	== Description ==		== Description ==

Maintenance script: audio node id/url + getaudio general

2026-08-01T19:28:46Z

audio node id/url + getaudio general

← Older revision		Revision as of 19:28, 1 August 2026
Line 2:		Line 2:

	== Description ==		== Description ==
	~~Serve~~ a locution or music-on-hold audio file ~~for preview,~~ base64-encoded (audio/wav). 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.		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 ==

Maintenance script: + getaudio

2026-08-01T19:06:07Z

+ getaudio

New page

''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''

== Description ==
Serve a locution or music-on-hold audio file for preview, base64-encoded (audio/wav). 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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX 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>id</code> || integer || Yes || — || Locution _id (kind=locution) or music _id (kind=music), from the simulatecall audio descriptor / getappactions.
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getaudio&ukey=KEY&pbx=tucall&kind=locution&id=1239</nowiki>

== 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]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]