API - Filas
Operações básicas para manipulação dos dados das filas.
Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.
Criação
Cria uma nova fila.
Endpoint | /api/v1/queues |
|---|---|
Method | POST |
Parâmetros
Corpo em JSON
name | obrigatório | Nome humanamente legível da fila. |
|---|---|---|
slug | opcional | Forma única e amigável a URLs do nome, escrito em minúsculo, sem caracteres especiais e com espaços substituídos por underscore. Por padrão o próprio sistema tentará arranjar um slug para o nome (e pode falhar caso já exista). |
number | obrigatório | Número na telefonia pelo qual a fila atenderá. |
public_number | opcional | Um DID já existente pelo qual a fila atenderá publicamente – se esse DID não existir, uma criação manual terá de ser feita. |
Exemplos de retorno
201 | {
"meta": {
"status": 200,
"message": "Created"
},
"data": {
"id": 42
}
} |
|---|---|
400 | {
"meta": {
"status": 400,
"message": "Missing required params"
}
} |
500 | {
"meta": {
"status": 500,
"message": "Data insertion may break a database constraint"
}
} |
Leitura de muitos
Recupera uma lista de filas.
Endpoint | /api/v1/queues |
|---|---|
Method | GET |
Parâmetros
Query na URL
include_archived | opcional | Se for igual a "true" irá incluir filas arquivadas |
|---|
Exemplos de retorno
200 |
|---|
Leitura individual
Recupera um única fila.
Endpoint | /api/v1/queues/{queue_id} |
|---|---|
Method | GET |
Parâmetros
No endpoint da URL
queue_id | obrigatório | Deve ser igual ao valor de um campo id de uma fila já existente. |
|---|
Query da URL
include_archived | opcional | Se for igual a "true" irá retornar a fila mesmo que ela esteja arquivada |
|---|
Exemplos de retorno
200 | |
|---|---|
404 | |
422 |
Edição
Recupera uma lista de filas.
Endpoint | /api/v1/queues/{queue_id} |
|---|---|
Method | PUT |
Parâmetros
No endpoint da URL
queue_id | obrigatório | Deve ser igual ao valor de um campo id de uma fila já existente. |
|---|
Corpo em Form-Data
name | opcional | Nome humanamente legível da fila. |
|---|---|---|
number | opcional | Número na telefonia pelo qual a fila atenderá. |
public_number | opcional | Um DID já existente pelo qual a fila atenderá publicamente – se esse DID não existir, uma criação manual terá de ser feita. |
max_wait_time | opcional | Máximo tempo de espera, em segundos, em que um ligador fica aguardando ser direcionado a um agente naquela fila. |
Exemplo de Requisição
Ex: Editar o tempo máximo de espera na fila |
|---|
Exemplos de retorno
200 | |
|---|---|
400 | |
404 | |
422 |
Arquivamento
Arquiva uma fila, tornando-a indiponível para ser habilitada e sua consulta fica parcialmente restringida.
Endpoint | /api/v1/queues/{queue_id} |
|---|---|
Method | DELETE |
Parâmetros
No endpoint da URL
queue_id | obrigatório | Deve ser igual ao valor de um campo id de uma fila já existente. |
|---|
Exemplos de retorno
200 | |
|---|---|
404 | |
422 |
Listar pausas
Endpoint | /api/v1/queues/{queue_id}/pauses |
|---|---|
Method | GET |
Query String
Nome | Valor Padrão | Valor Máximo |
|---|---|---|
limit | 50 | 50 |
page | 1 | - |
Exemplo de requisição