Agent

Retrieve call queue agent

Retrieve information of call queue agent.

get

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

Authorizations

Path parameters

idall ofrequired

The unique ID of user.

queue_idall ofrequired

The unique ID of call queue.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/users/{id}/call_queues/{queue_id}/agent' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "skill_level": 1,
  "status": "READY",
  "extension_number": "text",
  "display_name": "text"
}

OK

Set call queue agent status

Set call queue agent status.

post

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

Authorizations

Path parameters

idall ofrequired

The unique ID of user.

queue_idall ofrequired

The unique ID of call queue.

Body

statusstring · enum

Change call queue agent status to one of the following:

• READY:
• NOT_READY:
• WRAP_UP:
• BREAK:
• LUNCH:
• LOGGED_IN:
• LOGGED_OUT:

Example: READY

Options: READY, NOT_READY, WRAP_UP, BREAK, LUNCH, LOGGED_IN, LOGGED_OUT

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/users/{id}/call_queues/{queue_id}/agent' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"status":"READY"}'

200

4XX

200

No body

OK