URA (C)

Relatório: URA (C)

Descrição: Este relatório fornece estatísticas detalhadas sobre o uso do IVR (Interactive Voice Response) em um determinado período de tempo, incluindo informações sobre o ID do IVR, a extensão do IVR, o nome do IVR e o número de chamadas recebidas, transbordadas, abandonadas e aceitas.

Informações Gerais

Módulo: PABX

Versão: 1.0

Autor: I9Corp

E-mail de Suporte: support@i9corp.com.br

Endpoint para Gerar o Relatório

Para gerar este relatório, envie uma solicitação POST para o endpoint abaixo. Certifique-se de incluir o ID do IVR e os filtros de data de início e data de fim como parâmetros.

Endpoint:

{{HOST}}/service/v1/report/pabx-rtp-0002

Parâmetros da Solicitação

{
    "filters": [
        {
            "field": "ivrId",
            "selectedValue": "-1"
        },
        {
            "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": "3",
                "exten": "602",
                "name": "Teste aplicacao",
                "received": "0",
                "transhipment": "0",
                "abandon": "0",
                "accept": "0"
            },
            // Outras entradas do relatório...
        ]
    }
}

Propriedades da Resposta

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

Propriedade	Descrição	Tipo
`id`	ID do IVR	String
`exten`	Extensão do IVR	String
`name`	Nome do IVR	String
`received`	Número de chamadas recebidas pelo IVR	String
`transhipment`	Número de chamadas transbordadas pelo IVR	String
`abandon`	Número de chamadas abandonadas pelo IVR	String
`accept`	Número de chamadas aceitas pelo IVR	String

Lembre-se de substituir {{HOST}} pela URL real do host do seu serviço. Além disso, insira o ID do IVR e as datas de início e fim corretas como parâmetros.

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": "ivrId",
      "selectedValue": "-1"
    },
    {
      "field": "dateStart",
      "selectedValue": "2023-07-23 00:00:00"
    },
    {
      "field": "dateEnd",
      "selectedValue": "2023-07-23 23:59:59"
    }
  ],
  "format": "json"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200URA (C)

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

object

requerido

general

array [object {6}]

requerido

Exemplo

{
  "page": 1,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": {
    "general": [
      {
        "exten": "605",
        "name": "URA 5",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "604",
        "name": "URA 4",
        "received": "1",
        "transhipment": "1",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "606",
        "name": "URA 6",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "601",
        "name": "URA 1",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "600",
        "name": "URA 0",
        "received": "1",
        "transhipment": "1",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "602",
        "name": "URA 2",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "603",
        "name": "URA 3",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      },
      {
        "exten": "607",
        "name": "URA 7",
        "received": "0",
        "transhipment": "0",
        "abandon": "0",
        "accept": "0"
      }
    ]
  }
}

Relatório: URA (C)#

Informações Gerais#

Endpoint para Gerar o Relatório#

Parâmetros da Solicitação#

Resposta do Relatório#

Propriedades da Resposta#

Requisição

Exemplos de Requisição

Respostas

Relatório: URA (C)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta