Jump to content

TuCloudAPI updateagent

From Wiki 7Kas
Revision as of 14:31, 3 August 2026 by Maintenance script (talk | contribs) (TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Description

Update a queue member's penalty / paused / reason_paused (partial — only the fields sent are changed). Changing the queue or extension = deleteagent + addagent. Requires a non-readonly ukey. Phase 1 persists the table value; live pause via AMI is a later phase.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=updateagent&ukey=YOUR_KEY

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes FuturePBX name (tenant boundary).
id integer Yes Agent _id.
penalty integer No New penalty (omit to keep).
paused integer No 1=paused, 0=active (omit to keep).
reason_paused string No Pause reason (omit to keep; max 80).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updateagent&ukey=KEY&pbx=tucall&id=5001&paused=1&reason_paused=Descanso

Response

{ok, agent:{...}} or {ok:false,not_found}.


Back to TuCloudAPI