Jump to content

TuCloudAPI discardmusic

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

Tira el audio pendiente sin tocar la musica. Es una CORTESIA, no una obligacion: lo pendiente caduca solo a los 60 minutos, asi que si el usuario cierra la pestana tampoco queda basura. discarded=false significa que ya no habia nada pendiente, y no es un error. Requiere ukey de escritura.

Call

https://tucloudapi.7kas.com:9087/tucloud?func=discardmusic&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.
id integer Yes — Id de la clase de musica (_id).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=discardmusic&ukey=KEY&pbx=tucall&id=123

Response

{ok:true, discarded:true|false} o {ok:false,invalid_param|not_found}.

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