Agent Statuses

Lists the live status of customer representatives (extensions) and the queues they belong to. Used for a wall board, a "who is available" indicator in the CRM or a shift report. API key (scope call; Authorization: Bearer bt_… in the header, see API Security), GET.

Rate limit: 2 requests per minute. Do not loop this endpoint for per-second refreshing; live monitoring screen or CRM bridge data is more suitable.

GETAgent list

GET https://api.buluthat.com/api/agent_statuses.php
[
  { "agent": "1010", "status": "AVAILABLE", "queues": ["204", "205"] },
  { "agent": "1011", "status": "TALKING",   "queues": ["202"] },
  { "agent": "1026", "status": "ON_BREAK",  "queues": ["204"], "break_description": "Kahve" },
  { "agent": "1030", "status": "LOGGED_OUT", "queues": [] }
]
FieldDescription
agentExtension number
statusAVAILABLE available · TALKING in a conversation · ON_BREAK on break · LOGGED_OUT unregistered / offline
queuesThe queue numbers they belong to
break_descriptionBreak name if on break

Filters

ParameterDescription
agentSingle extension (1010)
statusStatus filter (AVAILABLE, TALKING, ON_BREAK, LOGGED_OUT)
queueMembers of a specific queue (queue number or name)
GET https://api.buluthat.com/api/agent_statuses.php?queue=204&status=AVAILABLE

Notes

  • Extensions with the mobile app may appear unregistered on the PBX when the screen is off; they are woken by push on an incoming call. At this endpoint LOGGED_OUT appearing does not mean "unreachable"; queue distribution counts a wakeable member as available.
  • If the extension has turned on "Do not disturb" (DND) ON_BREAK instead of LOGGED_OUT is visible.