Skip to main content
POST
Enviar uma mensagem de WhatsApp

Autorizações

Authorization
string
header
obrigatório

HTTP Basic onde o usuário é o e-mail da conta e a senha é o token de segurança.

Corpo

sender_name
string
obrigatório
sender_document
string
obrigatório

CPF/CNPJ do remetente.

recipient_name
string
obrigatório
recipient_phone
string
obrigatório

Normalizado para E.164.

recipient_document
string
obrigatório
template_id
integer
obrigatório

Deve ser um modelo aprovado pertencente ao remetente selecionado. Com remetentes de sistema, o modelo deve ter sido criado por você (ou pelo dono do seu time) ou ser compartilhado.

paymentMethod
enum<string>
obrigatório
Opções disponíveis:
escrybe_credits,
invoice,
team
team_member_id
integer

Obrigatório quando paymentMethod=team.

body
string
Maximum string length: 4096
template_variables
object

Mapa de substituições das variáveis do modelo. Deve cobrir ao menos a quantidade de variáveis do modelo.

media_url
string

Um entre media_url/media_file/media_base64 é obrigatório quando o formato do cabeçalho do modelo é IMAGE ou DOCUMENT.

media_filename
string
media_file
file

IMAGE JPEG/PNG ≤5MB; DOCUMENT PDF ≤100MB. PDFs com senha são rejeitados.

media_base64
string
sender_choice
string
padrão:system

system ou um remetente específico.

sender_id
integer

Remetente específico a utilizar.

Resposta

Mensagem criada e aguardando pagamento

Envelope padrão usado pelos endpoints de mensagens e remetentes de WhatsApp (mesmo formato dos envelopes de cartas e e-mail).

status
integer
Exemplo:

200

status_message
string
data
object