TuCloudAPI updateagent: Difference between revisions
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}} | |||
== Description == | == Description == | ||
| Line 5: | Line 7: | ||
== Call == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=updateagent&ukey=YOUR_KEY&pbx=PBX_NAME | |||
Requires the <code>ukey</code> parameter. | GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope. | ||
== Parameters == | == Parameters == | ||
| Line 16: | Line 18: | ||
| <code>id</code> || integer || Yes || — || Agent _id. | | <code>id</code> || integer || Yes || — || Agent _id. | ||
|- | |- | ||
| <code>penalty</code> || integer || No || — || New penalty (omit to keep). | | <code>penalty</code> || integer || No || — || New penalty: whole number 0-100 (omit to keep). Rejected with invalid_param if non-numeric or out of range. | ||
|- | |- | ||
| <code>paused</code> || integer || No || — || 1=paused, 0=active (omit to keep). | | <code>paused</code> || integer || No || — || 1=paused, 0=active (omit to keep); any other value is rejected with invalid_param. PERSISTED ONLY, not live: this writes the stored column, which a running queue engine does not see until its next member reload, and the engine owns this column and may overwrite it. Do not present it to the user as the current pause state. | ||
|- | |- | ||
| <code>reason_paused</code> || string || No || — || Pause reason (omit to keep; max 80). | | <code>reason_paused</code> || string || No || — || Pause reason (omit to keep; max 80). Advisory label only — the engine never sets or clears it, so it keeps whatever was last written here even if the agent was paused from a phone star code. `paused` is the truth, not this. | ||
|} | |} | ||
== Example == | == Example == | ||
| Line 27: | Line 29: | ||
== Response == | == Response == | ||
{ok, agent:{...}} or {ok:false,not_found}. | {ok, agent:{...}} or {ok:false,not_found}. | ||
== Errors == | |||
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function. | |||
---- | ---- | ||
Back to [[TuCloudAPI]] | Back to [[TuCloudAPI]] | ||
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | [[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | ||
Latest revision as of 21:17, 8 October 2026
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
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
https://tucloudapi.7kas.com:9087/tucloud?func=updateagent&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 (tenant boundary). |
id |
integer | Yes | — | Agent _id. |
penalty |
integer | No | — | New penalty: whole number 0-100 (omit to keep). Rejected with invalid_param if non-numeric or out of range. |
paused |
integer | No | — | 1=paused, 0=active (omit to keep); any other value is rejected with invalid_param. PERSISTED ONLY, not live: this writes the stored column, which a running queue engine does not see until its next member reload, and the engine owns this column and may overwrite it. Do not present it to the user as the current pause state. |
reason_paused |
string | No | — | Pause reason (omit to keep; max 80). Advisory label only — the engine never sets or clears it, so it keeps whatever was last written here even if the agent was paused from a phone star code. `paused` is the truth, not this. |
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}.
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