Agents
List call queue agents
Retrieve a collection of call queue agents.
GEThttp://127.0.0.1:8888/api/call_queues/{id}/agents
Path parameters
id*all of
The unique ID of call queue.
Response
OK
Body
itemsarray of object
Request
Response
Update call queue agent list
Update call queue agent list.
POSThttp://127.0.0.1:8888/api/call_queues/{id}/agents
Path parameters
id*all of
The unique ID of call queue.
Body
itemsarray of object
Collection of agents.
Response
OK
Request
Retrieve call queue agent
Retrieve information of call queue agent.
GEThttp://127.0.0.1:8888/api/call_queues/{id}/agents/{agent_number}
Path parameters
id*all of
The unique ID of call queue.
agent_number*string
The extension number.
Pattern:
[0-9]{3,64}
Response
OK
Body
extension_numberall of
The extension number of agent.
display_nameall of
The display name of agent.
skill_levelinteger (int32)
The skill level of agent in queue.
Only valid when polling_strategy
is skill based.
statusenum
Current status of agent:
READY
:NOT_READY
:QUEUE_CALL
:OTHER_CALL
:WRAP_UP
:BREAK
:LUNCH
:TRANSFER
:CONSULT_TRANSFER
:ON_HOLD
:LOGGED_OUT
:OFFLINE
:
READYNOT_READYQUEUE_CALLOTHER_CALLWRAP_UPBREAKLUNCHLOGGED_OUTOFFLINE
Request
Response
Set call queue agent status
Set call queue agent status.
POSThttp://127.0.0.1:8888/api/call_queues/{id}/agents/{agent_number}
Path parameters
id*all of
The unique ID of call queue.
agent_number*string
The extension number.
Pattern:
[0-9]{3,64}
Body
statusenum
Change call queue agent status to one of the following:
READY
:NOT_READY
:WRAP_UP
:BREAK
:LUNCH
:LOGGED_IN
:LOGGED_OUT
:
"READY"
READYNOT_READYWRAP_UPBREAKLUNCHLOGGED_INLOGGED_OUT
Response
OK
Request