Referência da API (V1.0)
  1. Relatórios

Rel. agendamentos

get
https://{subdominio}.cxm.pipe.run/api/v2/reports/schedules
Query Params
date-time
required

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

date-time
required

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

string
enum
required

Tipo de período.
Valores permitidos:

  • schedule_at: Agendado em
  • schedule_to: Agendado para

Allowed:
string
enum
required

Situação do agendamento.
Valores permitidos:

  • 1: Todos os agendamentos
  • 2: Somente agendamentos pendentes
  • 3: Somente agendamentos entregues

Allowed:
channel_id[]
array of int32s

ID's dos canais de atendimento

channel_id[]
int32

ID da conta específica

int32

ID do cliente

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[]
int32

ID do produto

int32

ID da carteira

queue_id[]
array of int32s

ID's das filas de atendimento

queue_id[]
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[]
int32

ID da organização do cliente

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'd das etiquetas de clientes

label_id[]
string

Telefone ou e-mail do cliente

string
enum

Ativar filtro para retornar apenas atendimentos expirados.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos críticos.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos com anúncios.

  • 0: Não
  • 1: Sim

Allowed:
Responses

Updated 8 months ago

Language
Credentials
Header
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago