Agents

List call queue agents

get

Retrieve a collection of call queue agents.

Authorizations
Path parameters
idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/call_queues/{id}/agents HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update call queue agent list

post

Update call queue agent list.

Authorizations
Path parameters
idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
Responses
200
OK
post
POST /api/call_queues/{id}/agents HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

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

Retrieve call queue agent

get

Retrieve information of call queue agent.

Authorizations
Path parameters
idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
agent_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Responses
200
OK
application/json
get
GET /api/call_queues/{id}/agents/{agent_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Set call queue agent status

post

Set call queue agent status.

Authorizations
Path parameters
idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
agent_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Body
statusstring · enumOptional

Change call queue agent status to one of the following:

  • READY:
  • NOT_READY:
  • WRAP_UP:
  • BREAK:
  • LUNCH:
  • LOGGED_IN:
  • LOGGED_OUT:
Example: READYPossible values:
Responses
200
OK
post
POST /api/call_queues/{id}/agents/{agent_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "status": "READY"
}
No content
PreviousPickupNextExclusive numbers