Listagem de Fila de Espera

Claro, aqui está a explicação em formato Markdown:

Endpoint: {{HOST}}/service/v1/queues

Método: POST

Descrição: Este endpoint permite criar uma solicitação POST para listar todas as filas de serviço disponíveis. O servidor processará a solicitação e retornará uma lista de filas no formato JSON. O objetivo é listar as filas de serviço existentes.

Corpo da Solicitação (JSON):
Nenhuma informação específica precisa ser enviada no corpo da solicitação POST.

Resposta de Sucesso:

Código de Status: 200 (OK)

Corpo da Resposta (JSON):

{
  "sEcho": 1,
  "page": 0,
  "iTotalRecords": 3,
  "iTotalDisplayRecords": 3,
  "aaData": [
      {
          "id": 1,
          "name": "Fila 1",
          "exten": "700",
          "enabled": true
      },
      {
          "id": 2,
          "name": "Fila 2",
          "exten": "701",
          "enabled": true
      },
      {
          "id": 3,
          "name": "Fila 3",
          "exten": "702",
          "enabled": true
      }
  ]
}

Campos da Resposta:

sEcho (Inteiro): Um número de sequência para controle de página, geralmente usado em tabelas paginadas.

page (Inteiro): A página atual da lista, normalmente começando em 0.

iTotalRecords (Inteiro): O número total de registros disponíveis no sistema, independentemente da página atual.

iTotalDisplayRecords (Inteiro): O número total de registros exibidos na página atual.

aaData (Array de Objetos): Uma matriz de objetos que contém informações sobre as filas disponíveis. Cada objeto representa uma fila e contém os seguintes campos:

id (Inteiro): O ID único da fila.

name (String): O nome da fila.

exten (String): A extensão associada à fila.

enabled (Booleano): Indica se a fila está habilitada (true) ou não (false).

Essa tabela fornece uma visão geral dos campos e de seus significados no JSON de resposta quando a lista de filas é consultada por meio do endpoint {{HOST}}/service/v1/queues usando uma solicitação POST.

Paginação

start (Inteiro): Este campo indica a posição de início da página de resultados. Ele define o índice inicial a partir do qual os resultados devem ser recuperados. No exemplo, start está definido como 0, o que significa que a página de resultados começa a partir do primeiro registro.

length (Inteiro): Este campo define o número máximo de registros que devem ser retornados em uma única página de resultados. No exemplo, length está definido como 10, o que significa que a página deve conter até 10 registros.

sEcho (Inteiro): O campo sEcho é frequentemente usado para rastrear solicitações de paginação. Cada vez que uma nova solicitação de página é feita, esse número de sequência é incrementado. Ele pode ser usado para garantir que as respostas correspondam às solicitações e evitar resultados desatualizados.

search (Objeto): Este campo é usado para configurar opções de pesquisa, mas no exemplo fornecido, parece estar configurado para desativar a pesquisa usando regex (expressões regulares). O campo regex está definido como false, o que significa que a pesquisa não deve usar expressões regulares.

Em resumo, esse JSON de paginação é usado para definir os parâmetros de uma solicitação de busca paginada, incluindo o início da página, o número máximo de registros por página, informações de rastreamento e configurações de pesquisa, como o uso de expressões regulares (neste caso, desativado). Isso é frequentemente utilizado em aplicações web para exibir grandes conjuntos de dados de forma paginada e controlada.

application/json

Body

Exemplo

{
    "page": 0,
    "iTotalRecords": 3,
    "iTotalDisplayRecords": 3,
    "aaData": [
        {
            "id": 1,
            "name": "Fila 1",
            "exten": "700",
            "enabled": true
        },
        {
            "id": 2,
            "name": "Fila 2",
            "exten": "701",
            "enabled": true
        },
        {
            "id": 3,
            "name": "Fila 3",
            "exten": "702",
            "enabled": true
        }
    ]
}

Listagem de Fila de Espera

Paginação

Requisição

Códigos de solicitação

Respostas

Listagem de Fila de Espera

Paginação#

Requisição

Códigos de solicitação

Respostas

Paginação