Campanha (D)

Relatório: Relatório do Discador (Detalhado)

Descrição: Este relatório fornece detalhes sobre as chamadas realizadas pelo discador, incluindo informações sobre a campanha, o contato, a data e hora da chamada, a duração, o resultado da chamada, o protocolo da chamada, a extensão do ramal do ramal da central, a extensão do agente e o nome do agente.

Informações Gerais

Módulo: Discador

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 o ID do discador, se desejar filtrar por um discador específico.

Endpoint:

{{HOST}}/service/v1/report/dialer-rtp-0006

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": "dialerId",
            "selectedValue": "-1"
        }
    ],
    "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": [
            {
                "campaign_name": "Nome da Campanha",
                "campaing_description": "Descrição da Campanha",
                "contact_name": "Nome do Contato",
                "contact_document": "Documento do Contato",
                "contact_optional": "Informação Opcional do Contato",
                "contact_phone_number": "Número de Telefone do Contato",
                "date": "Data e Hora da Chamada",
                "duration": "Duração da Chamada",
                "disposition": "Estado da Chamada",
                "protocol": "Protocolo da Chamada",
                "branch_exten": "Extensão do Ramal da Central",
                "agent_exten": "Extensão do Agente",
                "agent_name": "Nome do Agente"
            },
            // Outras entradas do relatório...
        ]
    }
}

Propriedades da Resposta

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

Propriedade	Descrição	Tipo
`campaign_name`	Nome da Campanha	String
`campaign_description`	Descrição da Campanha	String
`contact_name`	Nome do Contato	String
`contact_document`	Documento do Contato	String
`contact_optional`	Informação Opcional do Contato	String
`contact_phone_number`	Número de Telefone do Contato	String
`date`	Data e Hora da Chamada	String
`duration`	Duração da Chamada	String
`disposition`	Estado da Chamada	String
`protocol`	Protocolo da Chamada	String
`branch_exten`	Extensão do Ramal da Central	String
`agent_exten`	Extensão do Agente	String
`agent_name`	Nome do Agente	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 Bodyapplication/json

filters

array [object {2}]

requerido

field

string

requerido

selectedValue

string

requerido

format

string

requerido

Exemplo

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Campanha (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": [
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 1",
        "contact_document": "10417252641",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:52:35",
        "duration": "00:00:05",
        "disposition": "Atendida",
        "protocol": "1694267555.6",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 2",
        "contact_document": "10417252642",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:53:05",
        "duration": "00:00:04",
        "disposition": "Atendida",
        "protocol": "1694267585.14",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 3",
        "contact_document": "10417252643",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:53:42",
        "duration": "00:00:03",
        "disposition": "Atendida",
        "protocol": "1694267622.22",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 4",
        "contact_document": "10417252644",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:54:08",
        "duration": "00:00:07",
        "disposition": "Atendida",
        "protocol": "1694267648.31",
        "branch_exten": "",
        "agent_exten": ""
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 4",
        "contact_document": "10417252644",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:54:08",
        "duration": "00:00:03",
        "disposition": "Atendida",
        "protocol": "1694267648.30",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 5",
        "contact_document": "10417252645",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:54:38",
        "duration": "00:00:29",
        "disposition": "Atendida",
        "protocol": "1694267678.35",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 6",
        "contact_document": "10417252646",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 10:55:34",
        "duration": "00:00:06",
        "disposition": "Ocupado",
        "protocol": "1694267734.43",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 7",
        "contact_document": "10417252647",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 11:01:45",
        "duration": "00:00:03",
        "disposition": "Atendida",
        "protocol": "1694268105.48",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "Campanha Teste",
        "campaing_description": "Teste",
        "contact_name": "Wedson 6",
        "contact_document": "10417252646",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-09-09 11:02:11",
        "duration": "00:00:04",
        "disposition": "Atendida",
        "protocol": "1694268131.56",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "teste 16/10",
        "campaing_description": "teste 16/10",
        "contact_name": "wedson",
        "contact_document": "wedson",
        "contact_optional": "",
        "contact_phone_number": "5538991714633",
        "date": "2023-10-16 11:00:13",
        "duration": "00:00:06",
        "disposition": "Atendida",
        "protocol": "1697464813.30",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "teste 16/10",
        "campaing_description": "teste 16/10",
        "contact_name": "thiago",
        "contact_document": "thiago",
        "contact_optional": "",
        "contact_phone_number": "5538992176957",
        "date": "2023-10-16 11:00:43",
        "duration": "00:00:04",
        "disposition": "Atendida",
        "protocol": "1697464843.38",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      },
      {
        "campaign_name": "teste 16/10",
        "campaing_description": "teste 16/10",
        "contact_name": "Robert",
        "contact_document": "Robert",
        "contact_optional": "",
        "contact_phone_number": "5538997290002",
        "date": "2023-10-16 11:01:44",
        "duration": "00:00:04",
        "disposition": "Atendida",
        "protocol": "1697464904.46",
        "branch_exten": "2001",
        "agent_exten": "401",
        "agent_name": "Agente 2"
      }
    ]
  }
}

Relatório: Relatório do Discador (Detalhado)#

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: Relatório do Discador (Detalhado)

Informações Gerais

Endpoint para Gerar o Relatório

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta