View source for TuCloudAPI updateagent

''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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX name (tenant boundary).
|-
| <code>id</code> || integer || Yes || — || Agent _id.
|-
| <code>penalty</code> || integer || No || — || New penalty (omit to keep).
|-
| <code>paused</code> || integer || No || — || 1=paused, 0=active (omit to keep).
|-
| <code>reason_paused</code> || string || No || — || Pause reason (omit to keep; max 80).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updateagent&ukey=KEY&pbx=tucall&id=5001&paused=1&reason_paused=Descanso</nowiki>

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

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]