Skip to main content
POST
Enviar mensagem de texto

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Corpo

application/json
conversationId
string
obrigatório

ID da conversa

message
object
obrigatório
followup
string

ID do follow-up (opcional)

Resposta

Mensagem enviada com sucesso

content
string
obrigatório

Conteúdo da mensagem

content_type
enum<string>
obrigatório

Tipo de conteúdo: TEXT, IMAGE, AUDIO, VIDEO, DOCUMENT, TEMPLATE, etc.

Opções disponíveis:
TEXT,
CARDS,
AUDIO,
VIDEO,
IMAGE,
DOCUMENT,
CONTACTS,
LOCATION,
TEMPLATE,
STICKER,
UNSUPPORTED
message_type
enum<string>
obrigatório

Tipo de mensagem: INCOMING, OUTGOING, ACTIVITY

Opções disponíveis:
INCOMING,
OUTGOING,
ACTIVITY
status
enum<string>
obrigatório

Status da mensagem: SENT, DELIVERED, READ, FAILED

Opções disponíveis:
SENT,
DELIVERED,
READ,
FAILED
conversation
any
obrigatório

Conversa associada à mensagem

inbox
any
obrigatório

Inbox da mensagem

contact
any
obrigatório

Contato da mensagem

company
any
obrigatório

Empresa da mensagem

_id
string

ID da mensagem

additional_attributes
any

Atributos adicionais da mensagem

sender_type
enum<string>

Tipo do remetente: CONTACT, USER, BOT, SYSTEM

Opções disponíveis:
CONTACT,
USER,
BOT,
SYSTEM
source_id
string

ID da mensagem na plataforma externa

user
any

Usuário que enviou a mensagem

attachments
any[]

Anexos da mensagem

errors
object[]

Lista de erros associados à mensagem

createdAt
any

Data de criação da mensagem

updatedAt
any

Data de atualização da mensagem