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 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
"message": "Missing required params" |
|
"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
{
"id": 42,
"name": "Do not panic",
"slug": "do_not_panic",
"number": "1234",
"public_number": null |
|
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
},
"data": {
"id": 42,
"name": "Do not panic",
"slug": "do_not_panic",
"number": "1234",
"public_number": null |
|
"message": "Queue not found" |
|
"message": "Queue archived not requested" |
|
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
| 200 | {
"meta": {
"status": 200,
"message": "Updated"
}
} |
|---|
Ex: Editar o tempo máximo de espera na fila | | Code Block |
|---|
curl --location --request PUT 'https://[CLIENTE].evolux.net.br/api/v1/queues/9999' \
--header 'token: 123456cb-a1b2-1234-cccf-12345c67890' \
--form 'max_wait_time="13000"' |
|
|---|
Exemplos de retorno
"message": "Missing fields or trying to update slug" |
|
"message": "Queue not found" |
|
"message": "Archived queue can not be edited" |
|
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
"message": "Queue not found" |
|
"message": "Enabled queue can not be archived" |
|
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>' |
...