Dashboard — RZ Sender

Conexões salvas

Clique em Conectar para abrir a sessão (QR se necessário).

Conectar por nome

Escolha uma conexão

Nome da nova instância

Instâncias ativas

Instância

Destinatários

Use um número por linha. Para um único número, digite uma linha. Variáveis por linha: numero,var1,var2 (ex: 5511999999999,João,Plano A). Use no texto: {{var1}} e {{var2}}.

Intervalo entre envios (segundos)

Tempo aleatório entre cada envio (evita bloqueio).

Tipo de mensagem

Título

Texto

Opções

Rodapé

Usuários da Empresa

Nome	Email	Role	Status

Métricas do Sistema

Tenants -

Usuários -

Gestão de Tenants

Nome	Slug	Limite Instâncias	Limite Diário	Status

Gestão de Usuários

Nome	Email	Tenant	Role	Status

Gerenciamento de Tenants

Nome	Status	Limite Instâncias	Limite Diário	Último código enviado	Criado em	Ações
Carregando tenants...

Configuração de OTP (WhatsApp)

Configure canais de OTP (WhatsApp, Email e SMS).

Canais habilitados

WhatsApp Email SMS

WhatsApp Endpoint (POST)

WhatsApp Token de Autorização (Bearer)

WhatsApp Template do Body (JSON) Variáveis: {{number}}, {{code_otp}}, {{url_confimar_otp}}.

SMTP Host

SMTP Port

SMTP Secure (true/false)

SMTP User (Email remetente)

SMTP App Password

SMTP From (opcional)

SMS URL

SMS Auth Key

SMS Sender

Credenciais para Integração Externa

Use estas credenciais para outro sistema criar tenant, criar conexão e enviar mensagens.

URL Base da API

Token Bearer (sessão atual)

Header obrigatório: Authorization: Bearer SEU_TOKEN

Tenant Context para Super Admin

Gerador de Requisições (Playground)

Gere comandos cURL prontos para uso em segundos.

Novo

1. Instância de Envio

2. Número Destino (DDI+DDD+Num)

3. Formato da Mensagem

4. Conteúdo da Mensagem

Comando cURL Gerado

Aguardando dados...

JSON Body

{}

Preview no celular

Mensagem de preview

Documentação Completa da API (Super Admin)

Fluxo completo para integração externa: criar tenant, criar instância, obter QR e enviar todos os tipos de mensagem.

1) Credenciais e Base URL

Base URL: https://SEU_DOMINIO
Header obrigatório: Authorization: Bearer <TOKEN_JWT>
Content-Type: application/json

2) Criar novo Tenant (Super Admin)

POST /admin/tenants

{
  "name": "Empresa XPTO",
  "instance_limit": 3,
  "daily_send_limit": 1000
}

3) Criar instância para um tenant específico

POST /v1/instances

{
  "tenantId": "UUID_DO_TENANT",
  "instance": "main"
}

Quando o usuário é superadmin, envie tenantId no body (ou query).

4) Gerar e consultar QR da instância

GET /v1/instances/:name/qr

Resposta:
{
  "ok": true,
  "instance": "main",
  "qr": "data:image/png;base64,..."
}

GET /v1/instances?tenantId=UUID_DO_TENANT

Lista instâncias e status (connecting, qr, connected, disconnected).

5) Tipos de envio suportados

POST /v1/messages/send_text - Texto simples

{
  "instance": "main",
  "to": "5511999999999",
  "text": "Olá! Mensagem simples",
  "footer": "RZ Sender"
}

POST /v1/messages/send_image - Imagem

{
  "instance": "main",
  "to": "5511999999999",
  "imageUrl": "https://seu-cdn.com/oferta.jpg",
  "caption": "Confira nossa oferta!"
}

POST /v1/messages/send_video - Vídeo

{
  "instance": "main",
  "to": "5511999999999",
  "videoUrl": "https://seu-cdn.com/apresentacao.mp4",
  "caption": "Veja este vídeo"
}

6) Botões e interativos (todos)

POST /v1/messages/send_menu - Menu de Texto

{
  "instance": "main",
  "to": "5511999999999",
  "title": "Titulo",
  "text": "Corpo da mensagem",
  "footer": "Rodapé",
  "options": ["Opção 1", "Opção 2"]
}

POST /v1/messages/send_buttons_helpers - Botões de Resposta (Quick Reply)

{
  "instance": "main",
  "to": "5511999999999",
  "text": "Escolha uma opção:",
  "buttons": [
    { "id": "opt_1", "text": "Sim" },
    { "id": "opt_2", "text": "Não" }
  ],
  "footer": "Rodapé"
}

POST /v1/messages/send_interactive_helpers - Botões Interativos (CTA)

{
  "instance": "main",
  "to": "5511999999999",
  "text": "Assine agora:",
  "buttons": [
    { "type": "url", "text": "Google", "url": "https://google.com" },
    { "type": "copy", "text": "Copiar cupom", "copyCode": "CUPOM10" },
    { "type": "call", "text": "Ligar", "phoneNumber": "5511999999999" }
  ],
  "footer": "Rodapé"
}

POST /v1/messages/send_list_helpers - Listas (Dropdown)

{
  "instance": "main",
  "to": "5511999999999",
  "text": "Selecione:",
  "buttonText": "Ver Opções",
  "sections": [
    {
      "title": "Sessão 1",
      "rows": [
        { "title": "Item 1", "description": "Desc do item", "id": "id1" }
      ]
    }
  ],
  "footer": "Rodapé"
}

POST /v1/messages/send_poll - Enquetes

{
  "instance": "main",
  "to": "5511999999999",
  "name": "Qual sua cor favorita?",
  "options": ["Azul", "Verde"],
  "selectableCount": 1
}

POST /v1/messages/send_carousel_helpers - Carrossel com imagem e botões

{
  "instance": "main",
  "to": "5511999999999",
  "text": "Ofertas da semana",
  "footer": "RZ Sender",
  "cards": [
    {
      "title": "Plano Pro",
      "body": "Acesso completo",
      "footer": "Promoção",
      "imageUrl": "https://seu-cdn.com/plano-pro.jpg",
      "buttons": [
        { "id": "assinar_pro", "text": "Assinar" }
      ]
    }
  ]
}

7) Endpoint unificado para outro sistema

POST /api/integrations/send

{
  "instance": "main",
  "to": "5511999999999",
  "type": "image",
  "payload": {
    "imageUrl": "https://seu-cdn.com/arquivo.jpg",
    "caption": "Teste via endpoint unificado"
  }
}

GET /api/integrations/instances - Lista instâncias disponíveis para o tenant do token.

8) Exemplo rápido de fluxo (cURL)

# 1) Criar tenant
curl -X POST "$BASE/admin/tenants" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Empresa XPTO","instance_limit":3,"daily_send_limit":1000}'

# 2) Criar instância para tenant
curl -X POST "$BASE/v1/instances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"UUID_DO_TENANT","instance":"main"}'

# 3) Enviar texto
curl -X POST "$BASE/v1/messages/send_text" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"instance":"main","to":"5511999999999","text":"Olá do RZ Sender"}'