Skip to main content
Ao fim desta página você terá enviado uma mensagem de WhatsApp pela API e consultado o status dela.

Veja chegar no seu WhatsApp

Antes de configurar qualquer coisa, receba uma mensagem enviada pela API. Ela sai do número de demonstração da Arara e não exige conta. A demonstração roda esta chamada, a mesma que você vai fazer com a sua chave. É um template de carrinho abandonado com cobrança:
Para enviar do seu número, com os seus templates, siga os passos abaixo.

Antes de começar

Todo envio pela API é real e sai do seu número. Para o primeiro envio a sua organização precisa de:
  1. Plano assinado. Sem assinatura a API recusa o envio com 403 ACCOUNT_NOT_ACTIVATED. Assine em Faturamento. Veja os planos em Preços.
  2. Número conectado. Conecte em Números. Veja Números.
  3. Um template aprovado pela Meta. Crie em Templates. Veja Templates.
  4. Saldo na carteira. Recarregue em Faturamento. Veja Carteira.
Criar a conta e gerar a chave de API não exige plano. Você pode conectar o número e criar o template antes de assinar.

Passo a passo

1

Pegue sua chave de API

Crie uma chave em Chaves de API. O valor completo aparece uma única vez.Guarde em variável de ambiente:
Nunca coloque a chave no código, no frontend ou em repositório.
2

Envie a mensagem

Troque +5511999999999 pelo seu número de WhatsApp. Troque pedido_confirmado pelo nome do seu template aprovado e templateVariables pelos valores das variáveis dele, na ordem.
3

Veja a resposta

A API responde 202 Accepted. A mensagem foi aceita e entrou na fila de envio.
status começa em PENDING e passa por SENT, DELIVERED e READ, ou termina em FAILED com o motivo em reason. Na API o status vem em maiúsculas. No webhook vem em minúsculas (sent, delivered, read, failed).Guarde o id. Você usa ele no próximo passo.
4

Consulte o status

Troque ara_msg_k9Bf2Xq pelo id que você recebeu:
A resposta tem o mesmo formato do passo anterior, com o status atual.Em produção, não consulte em loop. Receba cada mudança de status por webhook.

Deu erro?

A resposta foi 202 mas a mensagem não chegou? Veja Erros de envio. A lista completa de recusas está em Erros.

Próximos passos

Webhooks

Receba status de entrega e mensagens dos clientes.

Templates

Categorias, aprovação e variáveis.

SDKs

Bibliotecas oficiais, incluindo Java e Go.

Convenções da API

Idempotência, paginação e rate limit.