Chamadas (D)

Relatório: Chamadas (D)

Descrição: Este relatório fornece detalhes sobre as chamadas registradas em um sistema de PABX (Private Automatic Branch Exchange) em um determinado período. Inclui informações como protocolo, ID da chamada, data e hora da chamada, duração, número de origem, destino, nome do destino, agente associado (se houver), status da chamada, tronco utilizado, tipo de chamada e duração da tarifação.

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 os filtros de data de início e data de fim como parâmetros, juntamente com outros filtros opcionais, como ID do tronco, ID do status e tipo de chamada.

Endpoint:

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

Parâmetros da Solicitação

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        },
        {
            "field": "dateEnd",
            "selectedValue": "YYYY-MM-DD HH:mm:ss"
        },
        {
            "field": "trunkId",
            "selectedValue": "-1"
        },
        {
            "field": "statusId",
            "selectedValue": "ALL"
        },
        {
            "field": "typeId",
            "selectedValue": "T"
        }
    ],
    "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": [
            {
                "protocol": "Protocolo",
                "id": "ID da Chamada",
                "date": "Data e Hora da Chamada",
                "duration": "Duração",
                "src": "Número de Origem",
                "dst": "Destino",
                "dst_name": "Nome do Destino",
                "agent": "Agente",
                "status": "Status da Chamada",
                "trunk": "Tronco",
                "tipo": "Tipo de Chamada",
                "transfer": "Transferência",
                "bill_sec": "Duração da Tarifação"
            },
            // Outras entradas do relatório...
        ]
    }
}

Propriedades da Resposta

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

Propriedade	Descrição	Tipo
`protocol`	Protocolo da chamada	String
`id`	ID da Chamada	String
`date`	Data e Hora da Chamada	String
`duration`	Duração da Chamada	String
`src`	Número de Origem	String
`dst`	Destino	String
`dst_name`	Nome do Destino	String
`agent`	Agente Associado	String
`status`	Status da Chamada	String
`trunk`	Tronco Utilizado	String
`tipo`	Tipo de Chamada	String
`transfer`	Transferência	String
`bill_sec`	Duração da Chamada com Tarifação	String

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

Requisição

Parâmetros Header

PreAuthorization

string

requerido

Exemplo:

Bearer {{authorization_key}}

Parâmetros Bodyapplication/json

filters

array [object {2}]

requerido

field

string

requerido

selectedValue

string

requerido

format

string

requerido

Exemplo

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "2023-03-01 00:00:00"
        },
        {
            "field": "dateEnd",
            "selectedValue": "2024-03-31 23:59:59"
        },
		{
            "field": "trunkId",
            "selectedValue": "-1"
        },
        {
            "field": "statusId",
            "selectedValue": "-1"
        },
        {
            "field": "typeId",
            "selectedValue": "-1"
        },
    ],
    "format": "json"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Chamadas (D)

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

object

requerido

general

array [object {13}]

requerido

Exemplo

{
  "page": 1,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": {
    "general": [
      {
        "protocol": "1672600405.4",
        "id": "23235",
        "date": "01-01-2023 16:13:25",
        "duration": "00:00:17",
        "src": "19974145001",
        "dst": "Aplicacao",
        "dst_name": "ivr-master",
        "agent": "",
        "status": "Atendida",
        "trunk": "Tronco teste Nvoip",
        "tipo": "Entrante",
        "transfer": "",
        "bill_sec": "00:00:16"
      }
    ]
  }
}

Relatório: Chamadas (D)#

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: Chamadas (D)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta