Agents

List call queue agents

Retrieve a collection of call queue agents.

get

/call_queues/{id}/agents

Authorizations

Path parameters

idall ofrequired

The unique ID of call queue.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

{
  "items": [
    {
      "skill_level": 1,
      "extension_number": "text",
      "display_name": "text"
    }
  ]
}

OK

Update call queue agent list

Update call queue agent list.

post

/call_queues/{id}/agents

Authorizations

Path parameters

idall ofrequired

The unique ID of call queue.

The unique ID of the resource.

Body

itemsobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_queues/{id}/agents' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "skill_level": 1,
        "extension_number": "text"
      }
    ]
  }'

200

4XX

200

No body

OK

Retrieve call queue agent

Retrieve information of call queue agent.

get

/call_queues/{id}/agents/{agent_number}

Authorizations

Path parameters

idall ofrequired

The unique ID of call queue.

The unique ID of the resource.

agent_numberstring · min: 3 · max: 64required

The extension number.

Pattern: [0-9]{3,64}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/call_queues/{id}/agents/{agent_number}' \
  --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

/call_queues/{id}/agents/{agent_number}

Authorizations

Path parameters

idall ofrequired

The unique ID of call queue.

The unique ID of the resource.

agent_numberstring · min: 3 · max: 64required

The extension number.

Pattern: [0-9]{3,64}

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/call_queues/{id}/agents/{agent_number}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "READY"
  }'

200

4XX

200

No body

OK