Jump to content

TuCloudAPI deletequeue

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

Delete a queue. Blocked {ok:false,in_use,refs} when a route step (app=10 "Cola") targets it (appdata = this queue id). Its members cascade via the queue_name FK. Requires a non-readonly ukey.

Call

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

Example

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

Response

{ok, _id} or {ok:false,in_use,refs:{routes}}.

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