Skip to main content
POST
Enviar uma mensagem via WhatsApp

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

instanceId
string<uuid>
obrigatório

UUID da instância WhatsApp

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Corpo

application/json
to
string
obrigatório

Número de telefone ou chatId do destinatário

type
enum<string>
obrigatório
Opções disponíveis:
text,
image,
video,
audio,
document,
location,
template,
poll,
contact,
forward,
reaction
body
string
media_url
string
caption
string
template_name
string
template_params
object
location
object
quoted_message_id
string

ID da mensagem para responder/citar

edit_message_id
string

ID da mensagem para editar

mentions
string[]

@menções (números de telefone com @c.us)

poll
object

Dados da enquete (type=poll)

contacts
object[]

Cartões de contato (type=contact)

forward_message_id
string

ID da mensagem para encaminhar (type=forward)

reaction
string

Emoji de reação (type=reaction), string vazia para remover

reaction_message_id
string

ID da mensagem para reagir (type=reaction)

Resposta

Mensagem enfileirada para envio

message
string
obrigatório

Mensagem de confirmação

Exemplo:

"Message queued for delivery"

jobId
string
obrigatório

ID do job BullMQ para rastreamento

Exemplo:

"42"