Skip to main content
POST
Criar novo mensagem

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

conversation_id
integer
obrigatório

O ID numérico da conversa

Corpo

application/json
content
string
obrigatório

O conteúdo da mensagem

Exemplo:

"Hello, how can I help you?"

message_type
enum<string>

O tipo da mensagem

Opções disponíveis:
outgoing,
incoming
Exemplo:

"outgoing"

private
boolean

Sinalizador (flag) para identificar se é uma nota privada

Exemplo:

false

content_type
enum<string>

Tipo de conteúdo da mensagem

Opções disponíveis:
text,
input_email,
cards,
input_select,
form,
article
Exemplo:

"text"

content_attributes
object

Atributos com base no tipo de conteúdo

Exemplo:
campaign_id
integer

O id da campanha à qual a mensagem pertence

Exemplo:

1

template_params
object

Parâmetros de modelo do WhatsApp para envio de mensagens estruturadas

Resposta

Sucesso

id
number

O ID da mensagem

content
string

O conteúdo de texto da mensagem

account_id
number

O ID da conta

inbox_id
number

O ID da caixa de entrada

conversation_id
number

O ID da conversa

message_type
enum<integer>

O tipo da mensagem

Opções disponíveis:
0,
1,
2,
3
created_at
integer

O horário em que a mensagem foi criada

updated_at

O horário em que a mensagem foi atualizada

private
boolean

As sinalizações (flags) que mostram se a mensagem é privada ou não

status
enum<string> | null

O status da mensagem

Opções disponíveis:
sent,
delivered,
read,
failed,
null
source_id
string | null

O ID de origem da mensagem

content_type
enum<string> | null

O tipo de mensagem de modelo

Opções disponíveis:
text,
input_text,
input_textarea,
input_email,
input_select,
cards,
form,
article,
incoming_email,
input_csat,
integrations,
sticker,
voice_call,
null
content_attributes
object

Os atributos de conteúdo para cada content_type

sender_type
enum<string> | null

O tipo de remetente

Opções disponíveis:
Contact,
User,
AgentBot,
Captain::Assistant,
null
sender_id
number | null

O ID do remetente

external_source_ids
object

Os IDs de origem externa da mensagem

additional_attributes
object

Os atributos adicionais da mensagem

processed_message_content
string | null

O conteúdo da mensagem processada

sentiment
object | null

O sentimento da mensagem

conversation
object | null

O objeto da conversa

attachment
object | null

O objeto de arquivo anexado à imagem

sender
object

Objeto Usuário/Agente/AgentBot