Queue
List queues, view a queue, list agents in a queue, show a queue agent, add and update a queue agent, and remove an agent from a queue.
List Queues
Returning a list of all queues on the account.
Request
GET https://api.telzio.com/queue/all
Response
{
[
{
"QueueId": integer,
"QueueName": string,
}
]
}
View Queue
Returning details about a specific queue, including agents and their current status along with any callers currently in the queue.
Request
GET https://api.telzio.com/queue/queue/{QueueId}/view
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| QueueId | int32 | The ID of a queue. |
Response
{
"Agents": [
{
"Username": string,
"State": string,
"GraceTimeSeconds": integer,
"Gracing": boolean,
"LastCallTaken": string,
"LastCallEnded": string,
}
],
"Participants": [
{
"QueueSessionId": string,
"CallerId": string,
"Position": integer,
"Joined": string,
"Released": boolean,
"Callback": boolean,
"CallbackNumber": string,
"RejectedByAgents": array,
"TimeInQueue": string,
}
]
}
List Agents in Queue
Returning a list of agents in a queue and their current status and grace time.
Request
GET https://api.telzio.com/queue/{id}/agents
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int32 | ID of a queue. |
Response
{
"QueueName": string,
"Agents": [
"samwise": {
"Available": boolean,
"GraceTimeSeconds": integer,
},
"frodo": {
"Available": boolean,
"GraceTimeSeconds": integer,
},
]
}
Show Queue Agent
Returning the current status for a specific agent in a queue.
Request
GET https://api.telzio.com/queue/{id}/agents/{username}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int32 | ID of a queue. |
| username | string | Username of the queue agent. |
Response
{
"Available": boolean,
"GraceTimeSeconds": integer,
}
Add or Update Queue Agent
Adds an agent to the queue or updates the availability and grace time if the agent is already in the queue.
Request
POST https://api.telzio.com/queue/{id}/agents/{username}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int32 | ID of a queue. |
| username | string | Username of the queue agent. |
Body Parameters
| Parameter | Type | Description | Default | |
|---|---|---|---|---|
| Available | boolean | ID of a queue. | Sets the availability of the Agent in the Queue. When updating an existing agent, this value can be omitted to preserve the current value. | false |
| GraceTimeSeconds | int32 | Username of the queue agent. | Sets the grace time (in seconds) of the Agent in the specified Queue. When updating an existing agent, this value can be omitted to preserve the current value. | 30 |
Response
{
"Available": boolean,
"GraceTimeSeconds": integer,
}
Remove Agent from Queue
Removes an agent from a queue.
Request
DELETE https://api.telzio.com/queue/{id}/agents/{username}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int32 | ID of a queue. |
| username | string | Username of the queue agent. |
