Agent

Retrieve call queue agent

get

Retrieve information of call queue agent.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

extension_numberall ofOptional

The extension number of agent.

string · min: 3 · max: 64Optional

The extension number.

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

display_nameall ofOptional

The display name of agent.

string · max: 1024Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

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

Default: 1

statusstring · enumRead-onlyOptional

Current status of agent:

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

Possible values:

4XX

Error

get

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

HTTPcURLJavaScriptPython

GET /api/users/{id}/call_queues/{queue_id}/agent 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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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

No content

4XX

Error

post

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

HTTPcURLJavaScriptPython

POST /api/users/{id}/call_queues/{queue_id}/agent HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "status": "READY"
}

No content