[DEPRECATED] Rel. atendimentos por clientes

get

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

Query Params

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:

1: Início do atendimento
2: Envio da mensagem
3: Final do atendimento

Allowed:

channel_id[]

array of int32s

ID's do canal de atendimento

channel_id[]

customer_id

int32

ID do cliente

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:

has_schedule

string

enum

Ativar filtro para retornar apenas atendimentos agendados.

0: Não
1: Sim

Allowed:

name

string

Nome do cliente

external_id

string

ID externo do cliente

document_number

string

Número de documento do cliente

number

string

Telefone do cliente

string

E-mail do cliente

wildcard_01

string

Curinga 1 do cliente

wildcard_02

string

Curinga 2 do cliente

wildcard_03

string

Curinga 3 do cliente

wildcard_04

string

Curinga 4 do cliente

wildcard_05

string

Curinga 5 do cliente

wildcard_06

string

Curinga 6 do cliente

wildcard_07

string

Curinga 7 do cliente

wildcard_08

string

Curinga 8 do cliente

wildcard_09

string

Curinga 9 do cliente

wildcard_10

string

Curinga 10 do cliente

agent_id

array of int32s

ID's de agentes fidelizados

agent_id

queue_id

array of int32s

ID's das filas fidelizadas

queue_id

has_whatsapp

string

enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um telefone com WhatsApp.

0: Não
1: Sim

Allowed:

has_sms

string

enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um telefone com SMS.

0: Não
1: Sim

Allowed:

has_email

string

enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um endereço de e-mail.

0: Não
1: Sim

Allowed:

Headers

string

required

Defaults to application/json

Content-Type

string

required

Defaults to application/json

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401

422422