Skip to main content
POST
cURL

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

token
string
required

Token da instância. Trate como senha.

Body

application/json
phone
string
required

Chat de destino: número só dígitos com DDI e DDD (5511988887777), grupo (<id>-group), canal (<id>@newsletter), LID (<id>@lid) ou status@broadcast.

Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
message
string
required
Required string length: 1 - 4096
button_label
string
required
Required string length: 1 - 20
title
string
Maximum string length: 256
Maximum string length: 256
reply_to_message_id
string

Id da mensagem a citar (responder), no mesmo chat.

Minimum string length: 1
mentioned
string[]

Números a mencionar; cada um precisa aparecer no texto como @<número>.

Maximum array length: 500
Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
mention_all
boolean

Em grupos, menciona todos os participantes.

delay_message
number

Segundos (0–15) de espera antes de enviar, substituindo o intervalo aleatório da instância (delay_message_min_ms/max_ms).

Required range: 0 <= x <= 15
delay_typing
number

Segundos (0–15) mostrando "digitando…" (ou "gravando…" em voice notes) antes de enviar. Padrão 0.

Required range: 0 <= x <= 15
custom_message_id
string

Id da mensagem no WhatsApp, escolhido por você (1–128 caracteres ASCII visíveis, sem espaços; ex.: cp_123). Vira o message_id da resposta e dos webhooks. Precisa ser único na instância. Repetir o id de uma mensagem na fila ou já enviada retorna 409 duplicate_message_id (o de uma que falhou pode ser reutilizado). Omita para o Wabox gerar. Não pode ser combinado com edit_message_id.

Pattern: ^[\x21-\x7E]{1,128}$
verify_phone
boolean

Confere o número no WhatsApp antes de enviar e manda para o número em que ele está registrado (ex.: com ou sem o nono dígito). Sem conta no WhatsApp, o envio falha com phone_not_on_whatsapp no webhook delivery. O Wabox guarda o resultado: mesmo sem esta opção, se o número já for conhecido, a mensagem vai para o número certo. O número usado chega em canonical_phone no delivery. Só vale para números (não para grupos, LIDs ou canais). Padrão false.

sections
object[]
Required array length: 1 - 10 elements
options
object[]
Required array length: 1 - 10 elements

Response

Mensagem enfileirada.

id
string
required
message_id
string
required
wabox_id
string
required
status
enum<string>
required
Available options:
queued