View source for TuCloudAPI getagents

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

== Description ==
List the PBX agents (queue members) with the queue title and the agent's extension name resolved. Optional queue_id filters to one queue. Tenant from (ukey, pbx). READ-only: the persisted paused flag comes from voip_queue_member; LIVE login/paused state (AstDB via AMI) is a later phase.

== Call ==
 GET  https://tucloudapi.7kas.com:9087/tucloud?func=getagents&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>queue_id</code> || integer || No || — || Optional: only members of this queue (_id from getagentlookups).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getagents&ukey=KEY&pbx=tucall</nowiki>

== Response ==
{ok, rows:[{_id,queue_id,queue,membername,interface,exten,agent_name,penalty,paused,reason_paused}]}.

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