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.
...
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 | { |
---|---|
400 | { |
500 | { |
Leitura de muitos
Recupera uma lista de filas.
...
include_archived | opcional | Se for igual a "true" irá incluir filas arquivadas |
---|
Exemplos de retorno
200 | { |
---|
Leitura individual
Recupera um única fila.
...
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.
...
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. |
Exemplos de retorno
200 | { |
---|---|
400 | { |
404 | { |
422 | { |
Arquivamento
Arquiva uma fila, tornando-a indiponível para ser habilitada e sua consulta fica parcialmente restringida.
...
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
Code Block | ||
---|---|---|
| ||
curl -X POST \
https://example.evolux.net.br/api/v1/queues/1/pauses?page=1&limit=2 \
-H 'Content-Type: application/json' \
-H 'token: <EVOLUX_TOKEN>' |
Exemplo de respostas
Code Block |
---|
{ "pagination": { "max_limit": 50, "limit": 50, "first_url": "https://example.evolux.net.br/api/v1/queues/1/pauses?page=1", "next_url": null, "items": 2, "last_url": "https://example.evolux.net.br/api/v1/queues/1/pauses?page=1", "total": 2, "current_url": "https://example.evolux.net.br/api/v1/queues/1/pauses?page=1", "prev_url": null }, "meta": { "status": 200, "message": "OK" }, "data": [ { "automatic_unpause": false, "limit_duration": 600, "pause": { "system": false, "productive": true, "type": "nr17rest10", "id": 1, "description": "10 minutos/NR17" }, "id": 3, "disable_unpause": false }, { "automatic_unpause": false, "limit_duration": 3600, "pause": { "system": false, "productive": false, "type": null, "id": 2, "description": "Almoço" }, "id": 4, "disable_unpause": false } ] } |