Skip to main content
Este guia te ajudará a começar com a API Disparador em poucos minutos. Siga os passos abaixo para configurar sua primeira campanha.

​
1. Registre sua empresa

Primeiro, você precisa registrar sua empresa para obter um access token: 
curl -X POST https://{url-key}/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Minha Empresa",
    "email": "[email protected]",
    "password": "senha123"
  }'

{
  "accessToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tokenType": "Access",
  "companyId": 1,
  "companyName": "Minha Empresa",
  "companyEmail": "[email protected]",
  "expiresAt": null,
  "message": null
}

​
2. Configure sua Evolution API

Certifique-se de que sua Evolution API está configurada e funcionando antes de prosseguir.
Você precisará fornecer nas requisições:
​
evolutionUrl
string
required
URL da sua Evolution API (ex: https://sua-evolution-api.com)
​
evolutionApiKey
string
required
Sua chave de API da Evolution
​
evolutionInstance
string
required
Nome da instância do WhatsApp conectada

​
3. Crie sua primeira campanha

Agora vamos criar uma campanha simples de texto: 
curl -X POST https://{url-key}/api/campaigns \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: {access_token}" \
  -d '{
    "name": "Campanha de Boas-vindas",
    "evolutionUrl": "https://sua-evolution-api.com",
    "evolutionApiKey": "sua-api-key",
    "evolutionInstance": "minha-instancia",
    "message": "Olá {PrimeiroNome}! Bem-vindo à nossa empresa!",
    "contacts": [
      {
        "phoneNumber": "5511999999999",
        "name": "João Silva"
      },
      {
        "phoneNumber": "5511888888888",
        "name": "Maria Santos"
      }
    ]
  }'

{
  "id": 1,
  "name": "Campanha de Boas-vindas",
  "status": "ACTIVE",
  "totalContacts": 2,
  "sentMessages": 0,
  "failedMessages": 0,
  "message": null
}

​
4. Acompanhe o progresso

Verifique o status da sua campanha: 
curl -X GET https://{url-key}/api/campaigns/{campaign_id} \
  -H "X-Access-Token: {access_token}"

{
  "id": 1,
  "name": "Campanha de Boas-vindas",
  "status": "ACTIVE",
  "totalContacts": 2,
  "sentMessages": 2,
  "failedMessages": 0,
  "createdAt": "2024-01-15T10:30:00",
  "message": null
}

​
5. Exemplo com mídia

Crie uma campanha com imagem: 
curl -X POST https://{url-key}/api/campaigns \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: {access_token}" \
  -d '{
    "name": "Campanha com Imagem",
    "evolutionUrl": "https://sua-evolution-api.com",
    "evolutionApiKey": "sua-api-key",
    "evolutionInstance": "minha-instancia",
    "message": "Confira nossa nova promoção!",
    "mediaUrl": "https://exemplo.com/imagem.jpg",
    "caption": "Oferta especial para você!",
    // mediaType é detectado automaticamente como "image"
    "contacts": [
      {
        "phoneNumber": "5511999999999",
        "name": "João Silva"
      }
    ]
  }'

​
6. Áudio com Texto

Envie um áudio com uma mensagem de texto complementar: 
curl -X POST https://{url-key}/api/campaigns \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: {access_token}" \
  -d '{
    "name": "Campanha de Áudio",
    "evolutionUrl": "https://sua-evolution-api.com",
    "evolutionApiKey": "sua-api-key",
    "evolutionInstance": "minha-instancia",
    "message": "Por favor, ouça as instruções acima com atenção.",
    "mediaUrl": "https://exemplo.com/instrucoes.mp3",
    "mediaType": "audio",
    "contacts": [
      {
        "phoneNumber": "5511999999999",
        "name": "João Silva"
      }
    ]
  }'
Comportamento do Áudio: O sistema envia primeiro o áudio, aguarda 1 segundo e depois envia a mensagem de texto.

​
7. Agendamento

Agende uma campanha para execução futura: 
curl -X POST https://{url-key}/api/campaigns \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: {access_token}" \
  -d '{
    "name": "Campanha Agendada",
    "evolutionUrl": "https://sua-evolution-api.com",
    "evolutionApiKey": "sua-api-key",
    "evolutionInstance": "minha-instancia",
    "message": "Lembrete: Reunião amanhã às 10h!",
    "scheduledFor": "2024-01-16T09:00:00",
    "contacts": [
      {
        "phoneNumber": "5511999999999",
        "name": "João Silva"
      }
    ]
  }'

​
8. Gerenciamento de campanhas

Pausar Campanha

Interrompe temporariamente o envio

Retomar Campanha

Continua uma campanha pausada

Cancelar Campanha

Cancela permanentemente a campanha

​
Pausar campanha

curl -X PUT https://{url-key}/api/campaigns/{campaign_id}/pause \
  -H "X-Access-Token: {access_token}"

​
Retomar campanha

curl -X PUT https://{url-key}/api/campaigns/{campaign_id}/resume \
  -H "X-Access-Token: {access_token}"

​
Cancelar campanha

curl -X PUT https://{url-key}/api/campaigns/{campaign_id}/cancel \
  -H "X-Access-Token: {access_token}"

​
9. Listar campanhas

Veja todas as suas campanhas: 
curl -X GET https://{url-key}/api/campaigns \
  -H "X-Access-Token: {access_token}"

​
Próximos Passos

Agora que você conhece o básico, explore mais funcionalidades:

Tipos de Mensagem

Conheça todos os tipos de mensagem suportados

Variáveis Personalizadas

Personalize suas mensagens com variáveis

Agendamento Avançado

Configure campanhas para execução futura

API Reference

Documentação completa da API

​
Precisa de ajuda?

Suporte por Email

[email protected]

GitHub Issues

Reporte bugs e solicite features

Documentação

Consulte a documentação completa
⌘I