Skip to navigation

Quickstart

Pré-requisitos

  • Uma conta no Muchaw DEV — cadastre-se aqui
  • Um número de WhatsApp conectado à sua conta (veja o Passo 2)

Passo 1 — Obtenha sua chave de API

Após se cadastrar, acesse o Dashboard → Chaves de API → Criar Chave.

Copie a chave imediatamente — ela é exibida apenas uma vez. Armazene-a com segurança (por exemplo, no seu arquivo .env).

MUCHAW_API_KEY=mk_live_...

Nunca exponha sua chave de API em código client-side ou repositórios públicos.


Passo 2 — Conecte um número de WhatsApp

A maneira mais fácil é criar um Link de Cadastro no Dashboard → Links de Cadastro → Criar Link.

Compartilhe o link com o dono do número. Eles completam um fluxo rápido de Embedded Signup do Facebook — seu número é registrado automaticamente.

Quando o número for ativado, você receberá um evento de webhook number.activated (se tiver um webhook configurado) e o status do número mudará para ACTIVE.

Você também pode recuperar o ID do número via API:

curl https://dev.muchau.com.br/api/numbers \
-H "Authorization: Bearer $MUCHAW_API_KEY"

Passo 3 — Envie uma mensagem

Use o ID do número do Passo 2 e o número de telefone do destinatário no formato internacional (ex: 5511999990000).

curl -X POST https://dev.muchau.com.br/api/messages/send \
-H "Authorization: Bearer $MUCHAW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"number_id": "<SEU_NUMBER_ID>",
"to": "5511999990000",
"type": "text",
"text": { "body": "Olá pelo Muchaw DEV!" }
}'

Resposta:

{
"id": "msg_01j...",
"wa_message_id": "wamid.HBgL...",
"status": "sent"
}

Passo 4 — Receba mensagens (opcional)

Crie um webhook para receber eventos em tempo real quando mensagens chegarem:

cURL
curl -X POST https://dev.muchau.com.br/api/webhooks \
-H "Authorization: Bearer $MUCHAW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://seu-servidor.com/webhooks/whatsapp",
"events": ["message.received", "message.delivered", "message.read"]
}'

Salve o secret da resposta — você precisará dele para verificar assinaturas de webhook.

Veja Receba Mensagens via Webhook para um guia completo de integração.