Chamada da fila (D)

Relatório: Chamada da fila (Detalhada)

Descrição: Este relatório detalha as chamadas recebidas na fila de um call center. Fornece informações sobre o telefone, DDD, número da fila, tempo em espera, tempo em ligação, situação da chamada e informações do agente associado à chamada.

Informações Gerais

Módulo: call-center

Versão: 1.0

Autor: I9Corp

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

Geração de Relatório: Endpoint e Parâmetros Essenciais

Para criar o relatório desejado, é necessário efetuar uma solicitação POST ao endpoint fornecido abaixo. Certifique-se de fornecer os três parâmetros cruciais: ID da fila, data de início e data de término.

Se o objetivo for obter todos os dados, sem aplicar um filtro específico ao campo "queueId," visando gerar um relatório completo, siga as orientações seguintes:

Atribua o valor "-1" ao campo "queueId" ao requisitar os dados. Isso indicará que nenhum critério de filtragem específico será aplicado a esse campo, permitindo que todos os dados disponíveis sejam incorporados ao relatório gerado.

Endpoint:

{HOST}/service/v1/report/call-center-rtp-0004

Parâmetros da Solicitação

Os seguintes parâmetros são obrigatórios para a solicitação:

Campo	Descrição
queueId	ID da Fila - Insira o ID da fila para a qual deseja gerar o relatório.
dateStart	Data de Início - Defina a data de início do período a ser abrangido pelo relatório.
dateEnd	Data de Término - Estabeleça a data de término do período a ser abrangido pelo relatório.

Exemplo de estrutura da solicitação:

{
  "queueId": "ID_DA_FILA",
  "dateStart": "AAAA-MM-DD",
  "dateEnd": "AAAA-MM-DD"
}

Substitua "ID_DA_FILA," "AAAA-MM-DD" e "AAAA-MM-DD" pelos valores correspondentes para obter um relatório personalizado de acordo com suas preferências. Estes parâmetros são indispensáveis para a geração correta do relatório.

Resposta do Relatório

O relatório será retornado no formato JSON, contendo as seguintes informações:

{
    "data": [
        {
            "phone": "Telefone",
            "ddd": "DDD",
            "queue_exten": "Numero da fila",
            "queue_name": "Fila",
            "te": "Tempo em espera",
            "ta": "Tempo em ligacao",
            "status": "Situacao",
            "date": "Recebida na fila",
            "answered": "Atendida",
            "completed": "Finalizada",
            "agent_exten": "Numero do agente",
            "agent_name": "Agente"
        },
        // Outras entradas do relatório...
    ]
}

Propriedades da Resposta

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

Propriedade	Descrição	Tipo
`phone`	Número de telefone da chamada	String
`ddd`	Código DDD do telefone	String
`queue_exten`	Número da fila da chamada	String
`queue_name`	Nome da fila da chamada	String
`te`	Tempo em espera da chamada (segundos)	Number
`ta`	Tempo em ligação da chamada (segundos)	Number
`status`	Situação da chamada	String
`date`	Data de recebimento na fila	String
`answered`	Indicador de chamada atendida (Sim/Não)	String
`completed`	Indicador de chamada finalizada (Sim/Não)	String
`agent_exten`	Número do agente associado à chamada	String
`agent_name`	Nome do agente associado à chamada	String

Lembre-se de substituir [URL_DO_ENDPOINT] pela URL real do endpoint para gerar o relatório. Além disso, insira o ID da fila e as datas de início e fim corretas como parâmetros.

Você pode copiar e colar esse script, substituindo os campos [URL_DO_ENDPOINT] e ID_DA_FILA pelos valores reais correspondentes, para documentar o relatório no Postman ou em outras plataformas de documentação. Certifique-se de preencher corretamente os valores dentro do array "data" com os resultados reais da API.

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"
    },
    {
      "field": "queueId",
      "selectedValue": "702"
    }
  ],
  "format": "json"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Chamada da fila (D)

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

object

requerido

general

array [object {12}]

requerido

Exemplo

{
  "page": 1,
  "iTotalRecords": 1,
  "iTotalDisplayRecords": 1,
  "aaData": {
    "general": [
      {
        "phone": "5538997290002",
        "ddd": "38",
        "queue_exten": "702",
        "queue_name": "Fila 3",
        "te": "00:00:08",
        "status": "Abandonada",
        "date": "09-03-2023 17:36:51",
        "completed": "09-03-2023 17:36:59"
      },
      {
        "phone": "5538997290002",
        "ddd": "38",
        "queue_exten": "702",
        "queue_name": "Fila 3",
        "te": "00:00:06",
        "ta": "00:00:01",
        "status": "Atendida",
        "date": "09-03-2023 17:36:51",
        "answered": "09-03-2023 17:36:57",
        "completed": "09-03-2023 17:36:58",
        "agent_exten": "2002",
        "agent_name": "Ramal 2002"
      },
      {
        "queue_exten": "702",
        "queue_name": "Fila 3",
        "te": "00:00:03",
        "ta": "00:00:09",
        "status": "Atendida",
        "date": "09-03-2023 17:42:05",
        "answered": "09-03-2023 17:42:08",
        "completed": "09-03-2023 17:42:17",
        "agent_exten": "2002",
        "agent_name": "Ramal 2002"
      }
    ]
  }
}

Chamada da fila (D)

Relatório: Chamada da fila (Detalhada)#

Informações Gerais#

Geração de Relatório: Endpoint e Parâmetros Essenciais#

Parâmetros da Solicitação#

Resposta do Relatório#

Propriedades da Resposta#

Requisição

Exemplos de Requisição

Respostas

Relatório: Chamada da fila (Detalhada)

Informações Gerais

Geração de Relatório: Endpoint e Parâmetros Essenciais

Parâmetros da Solicitação

Resposta do Relatório

Propriedades da Resposta