Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

User

Retrieve call queue agent

Retrieve information of call queue agent.

get/users/{id}/call_queues/{queue_id}/agent

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the user.

queue_idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the call queue.

Response

OK

extension_numberstring

The extension number.

display_namestring

The display name of user.

skill_levelinteger

The skill level of agent in queue.
Only valid when polling_strategy is skill based.

status'READY' | 'NOT_READY' | 'QUEUE_CALL' | 'OTHER_CALL' | 'WRAP_UP' | 'BREAK' | 'LUNCH' | 'LOGGED_OUT' | 'OFFLINE'

Current status of agent:

  • READY:
  • NOT_READY:
  • QUEUE_CALL:
  • OTHER_CALL:
  • WRAP_UP:
  • BREAK:
  • LUNCH:
  • TRANSFER:
  • CONSULT_TRANSFER:
  • ON_HOLD:
  • LOGGED_OUT:
  • OFFLINE: