Jump to content

TuCloudAPI addmusic: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig
 
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)
 
(One intermediate revision by the same user not shown)
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 ==
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>nombre</code> || string || Yes || — || MOH class/display name (letters/digits/_/-, max 32).
| <code>nombre</code> || string || Yes || — || MOH class/display name (letters/digits/_/-, max 32).

Latest revision as of 14:30, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Create a MOH class. nombre (letters/digits/_/-, max 32) is the class + display name; the server derives directory (moh/tucloud/<pbxname>/<nombre>/) + root and the DB trigger creates the realtime entry. Dedup on (pbx,nombre) -> conflict. NOTE: does NOT upload audio — the media server must write 1.wav into the returned directory. There is NO rename/edit (delete + re-add to rename). Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addmusic&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.
nombre string Yes MOH class/display name (letters/digits/_/-, max 32).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addmusic&ukey=KEY&pbx=tucall&nombre=Corporativa

Response

{ok, music:{_id,nombre,directory}} or {ok:false,conflict}.


Back to TuCloudAPI