Rel. atendimentos

get

https://{subdominio}.cxm.pipe.run/api/v2/reports/talks

Query Params

report_type

string

enum

required

Tipo de relatório.
Valores permitidos:

analytical: Relatório analítico
consolidated: Relatório consolidado
callbackForm: Relatório de formulários de callback
summary: Relatório de indicadores de atendimento

Allowed:

start_date

date-time

required

Data e hora inicial do período.
Formato: AAAA-MM-DD HH:MM

end_date

date-time

required

Data e hora final do período.
Formato: AAAA-MM-DD HH:MM

date_range_type

string

enum

required

Tipo de período.
Valores permitidos:

talk_start: Início do atendimento
talk_message_sent: Envio da mensagem
talk_end: Final do atendimento

Allowed:

channel_id[]

array of int32s

ID's dos canais de atendimento

channel_id[]

initial_sender_channel

int32

ID da conta específica

customer_id

int32

ID do cliente

branch_id

int32

ID da filial

agent_id[]

array of int32s

ID's dos agentes

agent_id[]

priority_id[]

array of int32s

ID's das prioridades de atendimento

priority_id[]

product_id

int32

ID do produto

card_id

int32

ID da carteira

queue_id[]

array of int32s

ID's das filas de atendimento

queue_id[]

tracking_number

string

Número do protocolo

event_id[]

array of int32s

ID's das tabulações

event_id[]

hashtag_id[]

array of int32s

ID's das hashtags

hashtag_id[]

is_finished

string

enum

Ativar filtro para retornar apenas atendimentos encerrados.
Valores permitidos:

0: Somente encerrados sem sucesso
1: Somente encerrados com sucesso
2: Todos os encerrados

Allowed:

callback_forms

int32

ID do formulário de callback

event_reaction_type[]

string

enum

Filtro disponível apenas quando tipo de relatório (report_type) for "callbackForm".
Tipos de reação das tabulações.
Valores permitidos:

f: Finalizar
w: Colocar em espera
n: Nenhuma

Allowed:

opening_type

string

enum

Tipo de abertura.
Valores permitidos:

all: Todos
out: Somente ativos
in: Somente receptivos

Allowed:

customer_organization_id

int32

ID da organização do cliente

string

Telefone ou e-mail do cliente

service_catalog_id

string

ID's dos catálogos de serviço (Separe os ID's com vírgulas)

category_id[]

array of int32s

ID's das categorias

category_id[]

label_id[]

array of int32s

ID's das etiquetas de clientes

label_id[]

message_type

string

enum

Filtro disponível apenas quando tipo de relatório (report_type) for "analytical".
Tipo de mensagens.
Valores permitidos:

is_template: Somente enviadas com templates
not_template: Somente enviadas sem templates
out: Todas mensagens enviadas
in: Todas mensagens recebidas

Allowed:

is_critical

string

enum

Ativar filtro para retornar apenas atendimentos críticos.

0: Não
1: Sim

Allowed:

was_expired

string

enum

Ativar filtro para retornar apenas atendimentos expirados.

0: Não
1: Sim

Allowed:

has_schedule

string

enum

Ativar filtro para retornar apenas atendimentos agendados.

0: Não
1: Sim

Allowed:

is_ads

string

enum

Ativar filtro para retornar apenas atendimentos com anúncios.

0: Não
1: Sim

Allowed:

is_success

string

enum

Filtro disponível apenas quando tipo de relatório (report_type) for "callbackForm".
Ativar filtro para retornar apenas atendimentos encerrados por tabulações positivas.

0: Não
1: Sim

Allowed:

group_type

string

enum

Filtro disponível apenas quando tipo de relatório (report_type) for "summary".
Tipo de agrupamento.

1: Por fila de atendimento
2: Por canal de atendimento
3: Ambos

Allowed:

Responses

200200

401401

422422