Skip to main content
GET
Obter outgoing mensagens count grouped by entity

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

Parâmetros de consulta

group_by
enum<string>
obrigatório

A entidade para agrupar as contagens de mensagens enviadas.

Opções disponíveis:
agent,
team,
inbox,
label
since
string

O timestamp de onde o relatório deve começar (Timestamp Unix).

until
string

O timestamp de onde o relatório deve parar (Timestamp Unix).

Resposta

Sucesso

id
number

O ID da entidade agrupada (agente, equipe, caixa de entrada ou rótulo).

name
string

O nome da entidade agrupada.

outgoing_messages_count
number

O número total de mensagens enviadas para esta entidade no intervalo de tempo determinado.

Exemplo: