URA (D)

Relatório: Registro de Navegação pela URA (Detalhado)

Descrição: Este relatório detalha o registro de navegação pela URA. Fornece informações sobre as interações dos usuários com a Unidade de Resposta Audível (URA) em determinado período, incluindo informações sobre a URA, data, dia da semana, origem, opções selecionadas, tipo de opção, situação, número do agente e nome do agente.

Informações Gerais

Módulo: pabx

Versão: 1.0.0-alpha

Autor: I9Corp

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

Endpoint para Gerar o Relatório

Para gerar este relatório, você pode enviar uma solicitação POST para o endpoint abaixo. Certifique-se de incluir o ID da URA, data de início e data de fim como parâmetros.

Se você deseja obter todos os dados sem um filtro específico para o campo "ivrId" e deseja gerar um relatório geral, siga estas instruções:

Adicione o valor "-1" ao campo "ivrId" ao solicitar os dados. Isso indicará que nenhum filtro específico deve ser aplicado a esse campo e, assim, todos os dados disponíveis serão incluídos no relatório gerado.

Endpoint:

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

Parâmetros da Solicitação

Nome	Descrição	Tipo
`ivrId`	ID da URA	Number
`dateStart`	Data de início do período	String
`dateEnd`	Data de fim do período	String

Exemplo de Corpo da Solicitação

{
    "ivrId": 123,
    "dateStart": "YYYY-MM-DD",
    "dateEnd": "YYYY-MM-DD"
}

Propriedades da Resposta

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

Propriedade	Descrição	Tipo
`exten`	Número da URA	String
`name`	Nome da URA	String
`date`	Data da interação	String
`day_week`	Dia da semana da interação	String
`source`	Número de origem da interação	String
`option_id`	Número da opção selecionada	Number
`type`	Tipo de opção selecionada	String
`resource_id`	ID da opção	Number
`description`	Descrição da opção	String
`status`	Situação da interação	String
`agent`	Número do agente associado à interação	String
`agent_name`	Nome do agente associado à interação	String

Exemplo de Resposta:

{
    "data": [
        {
            "exten": "123",
            "name": "URA Principal",
            "date": "2023-07-24 12:34:56",
            "day_week": "Segunda-feira",
            "source": "123456789",
            "option_id": 1,
            "type": "Menu",
            "resource_id": 101,
            "description": "Opção 1 - Atendimento",
            "status": "Concluída",
            "agent": "Agente1",
            "agent_name": "João Silva"
        },
        {
            "exten": "456",
            "name": "URA Secundária",
            "date": "2023-07-16 15:45:00",
            "day_week": "Sexta-feira",
            "source": "987654321",
            "option_id": 2,
            "type": "Menu",
            "resource_id": 202,
            "description": "Opção 2 - Suporte Técnico",
            "status": "Concluída",
            "agent": "Agente2",
            "agent_name": "Maria Souza"
        }
        // Outras entradas do relatório...
    ]
}

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": "200"
    },
    {
      "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

Relatório: Registro de Navegação pela URA (Detalhado)#

Informações Gerais#

Endpoint para Gerar o Relatório#

Parâmetros da Solicitação#

Exemplo de Corpo da Solicitação#

Propriedades da Resposta#

Requisição

Exemplos de Requisição

Respostas

Relatório: Registro de Navegação pela URA (Detalhado)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Exemplo de Corpo da Solicitação

Propriedades da Resposta