Relatório Percentual de Discagem (C)

Este documento descreve a API para obter o relatório percentual de discagem (C) a partir do serviço de call center. O relatório pode ser solicitado por meio de uma solicitação POST para a rota {{HOST}}/service/v1/report/dialer-rtp-0004.

Requisição

Rota

POST {{HOST}}/service/v1/report/dialer-rtp-0004

Corpo da Requisição (JSON)

O filtro a ser aplicado na solicitação é fornecido no corpo da requisição em formato JSON da seguinte maneira:

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "2023-07-23 00:00:00"
        },
        {
            "field": "dateEnd",
            "selectedValue": "2023-07-23 23:59:59"
        }
    ],
    "format": "json"
}

Resposta

A resposta da solicitação será um JSON contendo os dados percentuais de discagem. Os campos presentes na resposta são os seguintes:

queue: Fila.

queuename: Nome da fila.

dialer_id: ID do Dialer.

dialer_name: Nome do Dialer.

total: Total de discagens.

dialer: Número de discagens pelo Dialer.

pending: Discagens pendentes.

failure: Discagens com falha.

success: Discagens com sucesso.

dialer_per: Percentual de discagens pelo Dialer.

pending_per: Percentual de discagens pendentes.

failure_per: Percentual de discagens com falha.

success_per: Percentual de discagens com sucesso.

Aqui está um exemplo da resposta em formato JSON:

{
    "page": 1,
    "iTotalRecords": 1,
    "iTotalDisplayRecords": 1,
    "aaData": {
        "general": [
            {
                "queue": "700",
                "queuename": "Fila 1",
                "dialer_id": "449",
                "dialer_name": "Teste testando",
                "total": "193",
                "dialer": "0",
                "pending": "193",
                "failure": "0",
                "success": "0",
                "dialer_per": "0.00",
                "pending_per": "100.00",
                "failure_per": "0.00",
                "success_per": "0.00"
            }
        ]
    }
}

Tabela de Retorno

Aqui está uma tabela descrevendo os tipos de retorno recebidos na resposta:

Campo	Descrição	Tipo
queue	Fila	String
queuename	Nome da fila	String
dialer_id	ID do Dialer	String
dialer_name	Nome do Dialer	String
total	Total de discagens	String
dialer	Número de discagens pelo Dialer	String
pending	Discagens pendentes	String
failure	Discagens com falha	String
success	Discagens com sucesso	String
dialer_per	Percentual de discagens pelo Dialer	String
pending_per	Percentual de discagens pendentes	String
failure_per	Percentual de discagens com falha	String
success_per	Percentual de discagens com sucesso	String

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": "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

🟢200Percentual de discagem (C)

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": [
      {
        "queue": "700",
        "queuename": "Fila 1",
        "dialer_id": "449",
        "dialer_name": "Teste testando",
        "total": "193",
        "dialer": "0",
        "pending": "193",
        "failure": "0",
        "success": "0",
        "dialer_per": "0.00",
        "pending_per": "100.00",
        "failure_per": "0.00",
        "success_per": "0.00"
      },
      {
        "queue": "700",
        "queuename": "Fila 1",
        "dialer_id": "450",
        "dialer_name": "Nova_Cintra_1",
        "total": "576",
        "dialer": "0",
        "pending": "576",
        "failure": "0",
        "success": "0",
        "dialer_per": "0.00",
        "pending_per": "100.00",
        "failure_per": "0.00",
        "success_per": "0.00"
      },
      {
        "queue": "701",
        "queuename": "Fila 2",
        "dialer_id": "451",
        "dialer_name": "Nova_cintra_2",
        "total": "156",
        "dialer": "0",
        "pending": "156",
        "failure": "0",
        "success": "0",
        "dialer_per": "0.00",
        "pending_per": "100.00",
        "failure_per": "0.00",
        "success_per": "0.00"
      },
      {
        "queue": "700",
        "queuename": "Fila 1",
        "dialer_id": "453",
        "dialer_name": "Campanha Teste",
        "total": "7",
        "dialer": "7",
        "pending": "3",
        "failure": "0",
        "success": "4",
        "dialer_per": "100.00",
        "pending_per": "42.86",
        "failure_per": "0.00",
        "success_per": "57.14"
      }
    ]
  }
}

Percentual de discagem (C)

Relatório Percentual de Discagem (C)#

Requisição#

Rota#

Corpo da Requisição (JSON)#

Resposta#

Tabela de Retorno#

Requisição

Exemplos de Requisição

Respostas

Relatório Percentual de Discagem (C)

Requisição

Rota

Corpo da Requisição (JSON)

Resposta

Tabela de Retorno