Jump to content

TuCloudAPI addmusic

From Wiki 7Kas

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

ℹ Requires the 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

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

https://tucloudapi.7kas.com:9087/tucloud?func=addmusic&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.
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}.

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