TuCloudAPI addagent: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || string || Yes || — || FuturePBX name (tenant boundary). | ||
|- | |- | ||
| <code>queue_id</code> || integer || Yes || — || Queue _id (from getagentlookups.queues). | | <code>queue_id</code> || integer || Yes || — || Queue _id (from getagentlookups.queues). | ||
Latest revision as of 14:30, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Add an extension to a queue as a static member. The server derives membername (Agent/<sipuser>), interface (SIP/<sipuser>), name and exten from the extension (ext_id) + queue (queue_id); sipuser = the extension SIP user. Requires a non-readonly ukey. A queue can hold many agents and an agent can be in many queues; the only duplicate is the same agent already in that same queue -> conflict.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addagent&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX name (tenant boundary). |
queue_id |
integer | Yes | — | Queue _id (from getagentlookups.queues). |
ext_id |
integer | Yes | — | Extension _id (from getagentlookups.extensions). |
penalty |
integer | No | 0 |
Member penalty (0 = highest priority). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addagent&ukey=KEY&pbx=tucall&queue_id=1001&ext_id=104081
Response
{ok, agent:{_id,queue_id,queue,membername,interface,exten,agent_name,penalty,paused,reason_paused}} or {ok:false,conflict}.
Back to TuCloudAPI