Skip to main content

​
Visão geral

Este fluxo mostra o caminho mínimo para criar uma instância, conectar o número e enviar a primeira mensagem usando a EZ API.
Você precisa do seu Client-Token, disponível no Dashboard EZ API.

​
1. Crie a instância

A resposta retorna instanceId e instanceToken, que serão usados nas rotas seguintes. 
curl -X POST 'https://api.ezapi.com.br/instances' \
  -H 'Client-Token: SEU_CLIENT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Minha Instância",
    "receivedCallbackUrl": "https://example.com/webhooks/received",
    "deliveryCallbackUrl": "https://example.com/webhooks/delivery",
    "disconnectedCallbackUrl": "https://example.com/webhooks/disconnected",
    "connectedCallbackUrl": "https://example.com/webhooks/connected",
    "antiBanEnabled": false
  }'

{
  "instanceId": "abc1234567890",
  "instanceToken": "tok_a1b2c3d4e5f6",
  "status": "pending"
}
O instanceToken é retornado na criação e deve ser armazenado com segurança. Ele faz parte da URL de todas as rotas da instância.

​
2. Conecte o número

Se preferir exibir o QR Code diretamente no navegador ou no painel, use a versão em PNG: 
curl -X GET \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/qr-code/image' \
  -H 'Client-Token: SEU_CLIENT_TOKEN' \
  --output qrcode.png
Como alternativa, você pode solicitar um código de pareamento por telefone: 
curl -X GET \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/phone-code/5511999999999' \
  -H 'Client-Token: SEU_CLIENT_TOKEN'

{
  "pairingCode": "AZK7-KH39"
}

​
3. Verifique o status da conexão

curl -X GET \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/status' \
  -H 'Client-Token: SEU_CLIENT_TOKEN'

{
  "connected": true,
  "status": "CONNECTED",
  "instanceId": "abc1234567890"
}

​
4. Envie a primeira mensagem

curl -X POST \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/send-text' \
  -H 'Client-Token: SEU_CLIENT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "5511999999999",
    "message": "Olá. Esta é minha primeira mensagem com a EZ API.",
    "delayMessage": 15
  }'

{
  "messageId": "3EB047ED70306656281B34",
  "id": "3EB047ED70306656281B34"
}
Os envios de mensagens retornam 202 Accepted quando entram na fila da instância. Use webhooks para acompanhar confirmação, falha e mudanças de status em tempo real.

​
5. Configure um webhook de recebimento

curl -X PUT \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/update-webhook-received' \
  -H 'Client-Token: SEU_CLIENT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": "https://example.com/webhooks/received"
  }'

{
  "value": "https://example.com/webhooks/received"
}

​
Próximos passos

Referência completa

Consulte a estrutura da API, autenticação, erros e organização final da documentação.

Webhooks

Veja todos os eventos disponíveis e exemplos reais de payload.

Mensagens

Explore envios de mídia, interativos, listas, enquetes e diagnósticos.

Grupos

Crie grupos e gerencie participantes, links e permissões.