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.

...

Parâmetros

Corpo em JSON

...

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).

...

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

...

{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": {
    "id": 42
  }
}

...

{
  "meta": {
    "status": 400,
    "message": "Missing required params"
  }
}

...

{
  "meta": {
    "status": 500,
    "message": "Data insertion may break a database constraint"
  }
}

Leitura de muitos

Recupera uma lista de filas.

...

Parâmetros

Query na URL

...

Exemplos de retorno

...

{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": [
    {
      "id": 42,
      "name": "Do not panic",
      "slug": "do_not_panic",
      "number": "1234",
      "public_number": null
    },
    { 
      "id": 666, 
      "name": "Highway to Hell", 
      "slug": "highway_to_hell", 
      "number": "666", 
      "public_number": "999"
    }
  ]
}

Leitura individual

Recupera um única fila.

...

Parâmetros

No endpoint da URL

...

Query da URL

...

Exemplos de retorno

...

{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": {
    "id": 42,
    "name": "Do not panic",
    "slug": "do_not_panic",
    "number": "1234",
    "public_number": null
  }
}

...

{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}

...

{
  "meta": {
    "status": 422,
    "message": "Queue archived not requested"
  }
}

Edição

Recupera uma lista de filas.

...

Parâmetros

No endpoint da URL

...

Corpo em JSON

...

Um DID já existente pelo qual a fila atenderá publicamente – se esse DID não

existir, uma criação manual terá de ser feita.

...

Máximo tempo de espera, em segundos, em que um ligador fica aguardando ser

direcionado a um agente naquela fila.

Exemplos de retorno

...

{
  "meta": {
    "status": 200,
    "message": "Updated"
  }
}

...

{
  "meta": {
    "status": 400,
    "message": "Missing fields or trying to update slug"
  }
}

...

{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}

...

{
  "meta": {
    "status": 422,
    "message": "Archived queue can not be edited"
  }
}

Arquivamento

Arquiva uma fila, tornando-a indiponível para ser habilitada e sua consulta fica parcialmente restringida.

...

Parâmetros

No endpoint da URL

...

Exemplos de retorno

...

{
  "meta": {
    "status": 200,
    "message": "Arquived"
  }
}

...

{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}

...

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

Code Block
{ "meta": { "status": 200, "message": "Created" }, "data": { "id": 42 } }

400

Code Block
{ "meta": { "status": 400, "message": "Missing required params" } }

500

Code Block
{ "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

Code Block

{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": [
    {
      "id": 42,
      "name": "Do not panic",
      "slug": "do_not_panic",
      "number": "1234",
      "public_number": null
    },
    { 
      "id": 24, 
      "name": "Expresso 2222", 
      "slug": "expresso_2222", 
      "number": "2222", 
      "public_number": "2222"
    }
  ]
}

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

Code Block
{ "meta": { "status": 200, "message": "Created" }, "data": { "id": 42, "name": "Do not panic", "slug": "do_not_panic", "number": "1234", "public_number": null } }

404

Code Block
{ "meta": { "status": 404, "message": "Queue not found" } }

422

Code Block
{ "meta": { "status": 422, "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

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

200

Code Block
{ "meta": { "status": 200, "message": "Updated" } }

400

Code Block
{ "meta": { "status": 400, "message": "Missing fields or trying to update slug" } }

404

Code Block
{ "meta": { "status": 404, "message": "Queue not found" } }

422

Code Block
{ "meta": { "status": 422, "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

200

Code Block
{ "meta": { "status": 200, "message": "Arquived" } }

404

Code Block
{ "meta": { "status": 404, "message": "Queue not found" } }

422

Code Block
{ "meta": { "status": 422, "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

language	bash

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
        }
    ]
}

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Criação

Parâmetros

Corpo em JSON

Exemplos de retorno

Leitura de muitos

Parâmetros

Query na URL

Exemplos de retorno

Leitura individual

Parâmetros

No endpoint da URL

Query da URL

Exemplos de retorno

Edição

Parâmetros

No endpoint da URL

Corpo em JSON

Exemplos de retorno

Arquivamento

Parâmetros

No endpoint da URL

Exemplos de retorno

Criação

Parâmetros

Corpo em JSON

Exemplos de retorno

Leitura de muitos

Parâmetros

Query na URL

Exemplos de retorno

Leitura individual

Parâmetros

No endpoint da URL

Query da URL

Exemplos de retorno

Edição

Parâmetros

No endpoint da URL

Corpo em Form-Data

Exemplo de Requisição

Exemplos de retorno

Arquivamento

Parâmetros

No endpoint da URL

Exemplos de retorno

Listar pausas

Query String

Exemplo de respostas