URA histórico requisições - Autoatendimento (D)

URA Histórico de Requisições - Autoatendimento (D)

Descrição: Este relatório detalha o histórico de requisições do autoatendimento da URA (Unidade de Resposta Audível). Ele fornece informações sobre cada requisição, incluindo o ID da requisição, número de telefone associado, data da requisição, documento associado, estado da requisição, data de localização e se foi encontrado ou não.

Informações Gerais

Módulo: URA

Versão: 1.0

Autor: [Nome da Empresa]

E-mail de Suporte: [support@exemplo.com]

Endpoint para Gerar o Relatório

Para gerar este relatório, você pode enviar uma solicitação POST para o endpoint abaixo:

Endpoint:

Parâmetros da Solicitação

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        },
        {
            "field": "dateEnd",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        }
    ],
    "format": "json"
}

Resposta do Relatório

O relatório será retornado no formato JSON, contendo as seguintes informações:

{
    "page": 1,
    "iTotalRecords": 1,
    "iTotalDisplayRecords": 1,
    "aaData": {
        "general": [
            {
                "id": "ID da Requisição",
                "phone": "Número de Telefone",
                "date": "Data da Requisição",
                "document": "Documento Associado",
                "state_id": "ID do Estado da Requisição",
                "state_label": "Situação do Estado",
                "found": "Data de Localização",
                "it_found": "Encontrado (Sim/Não)"
            },
            // Outras entradas do relatório...
        ]
    }
}

Propriedades da Resposta

As propriedades a seguir são retornadas no formato JSON:

Propriedade	Descrição	Tipo
`id`	ID da requisição	String
`phone`	Número de telefone	String
`date`	Data da requisição	String
`document`	Documento associado	String
`state_id`	ID do estado da requisição	String
`state_label`	Situação do estado da requisição	String
`found`	Data de localização	String
`it_found`	Indicador de localização	String

Observações

Certifique-se de substituir {{HOST}} pela URL real do serviço.

Insira as datas de início e fim corretas como parâmetros.

O formato de data e hora deve ser YYYY-MM-DD HH:mm:ss.

Requisição

Parâmetros Header

PreAuthorization

string

requerido

Exemplo:

Bearer {{access_token}}

Parâmetros Bodyapplication/json

filters

array [object {2}]

requerido

field

string

requerido

selectedValue

string

requerido

format

string

requerido

Exemplo

{
  "filters": [
    {
      "field": "dateStart",
      "selectedValue": "2024-02-01 00:00:00"
    },
    {
      "field": "dateEnd",
      "selectedValue": "2024-02-27 23:59:59"
    }
  ],
  "format": "json"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200URA histórico requisições - Autoatendimento (D)

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

object

requerido

general

array [object {8}]

requerido

Exemplo

{
  "page": 1,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": {
    "general": [
      {
        "id": "18",
        "phone": "553899380640",
        "date": "2024-02-24 15:23:12",
        "document": "00102052689",
        "state_id": "2",
        "state_label": "Conectato/Ativo",
        "found": "2024-02-24 15:23",
        "it_found": "Sim"
      },
      {
        "id": "19",
        "phone": "553899380640",
        "date": "2024-02-24 15:38:43",
        "document": "00102052689",
        "state_id": "2",
        "state_label": "Conectato/Ativo",
        "found": "2024-02-24 15:38",
        "it_found": "Sim"
      },
      {
        "id": "20",
        "phone": "553899380640",
        "date": "2024-02-24 15:43:42",
        "document": "00102052689",
        "state_id": "2",
        "state_label": "Conectato/Ativo",
        "found": "2024-02-24 15:43",
        "it_found": "Sim"
      }
    ]
  }
}

URA histórico requisições - Autoatendimento (D)

URA Histórico de Requisições - Autoatendimento (D)#

Informações Gerais#

Endpoint para Gerar o Relatório#

Parâmetros da Solicitação#

Resposta do Relatório#

Propriedades da Resposta#

Observações#

Requisição

Exemplos de Requisição

Respostas

URA Histórico de Requisições - Autoatendimento (D)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta

Observações