Jump to content

TuCloudAPI commitlocution

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

Acepta el audio pendiente (el generado por synthlocution o subido por uploadlocution) y lo convierte en la locucion. ESTE es el unico punto en el que se sustituye el audio que oyen quienes llaman y se retiran los formatos antiguos; hasta aqui nada ha cambiado. Guarda ademas tts_text/tts_voice si lo pendiente venia de una sintesis, o los VACIA si venia de un fichero subido, porque un audio subido ya no es lo que decia ese texto. Del audio anterior se conserva una copia, de modo que aceptar por error es reversible. Si no hay nada pendiente, o ha caducado, responde no_preview y no toca nada. Requiere ukey de escritura.

Call

https://tucloudapi.7kas.com:9087/tucloud?func=commitlocution&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 locucion (_id).

Example

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

Response

{ok, locution:{...,tts_text,tts_voice}} o {ok:false,invalid_param|not_found|no_preview|io_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