Ir para o conteúdo

API em cascata

A API Cascade permite o envio de mensagens em diversas plataformas com uma única solicitação, roteando automaticamente para Telegram Bot, Viber Bot, Viber Business Messages, RCS e SMS.

URL base

https://restapi.smsbat.com

Autenticação

A API Cascade usa autenticação baseada em cabeçalho com três cabeçalhos de autenticação possíveis:

Método 1: Chave de API SMSBAT

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Authorization-Key: your-smsbat-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Método 2: Token do Viber Bot

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Viber-Auth-Token: your-viber-bot-token" \
  -H "Content-Type: application/json" \
  -d @request.json

Método 3: Chave do bot do Telegram

CODE_BLOCO_3

Terminais disponíveis

Método Ponto final Descrição
POSTAR /api/CascadeMessage/send_message/async Envio geral de mensagens em cascata
POSTAR /api/CascadeMessage/send_message/tg-viber/async Cascata priorizada por telegrama

Como funciona

Com uma única solicitação de API, o Cascade entrega automaticamente sua mensagem em vários canais:

Telegram Bot → Viber Bot → Viber Business → RCS → SMS

A mensagem é entregue através do primeiro canal disponível, com retorno automático para o próximo canal se a entrega falhar.

Principais recursos

Entrega multicanal

Envie uma mensagem e alcance usuários em qualquer plataforma:

  • Bot de telegrama
  • Bot Viber
  • Mensagens comerciais do Viber
  • RCS (serviços de comunicação ricos) -SMS

Substituição de variáveis

Use conteúdo dinâmico com espaços reservados variáveis:

  • %name=id% - Variáveis de texto
  • %url=id% - variáveis de URL
  • %short_url=id% - Variáveis de URL encurtadas

Agendamento de mensagens

Programe mensagens para entrega futura:

CODE_BLOCO_5

Tempo de vida (TTL)

Defina o prazo de validade das mensagens:

{
  "ttl": 3600
}

Tipos de mensagens

A API Cascade suporta:

  • Transacional - Confirmações de pedidos, notificações
  • Promoção - Mensagens promocionais e de marketing
  • Viber Surveys - Pesquisas interativas
  • Chamadas Flash - Verificação de telefone

Formato de resposta

Retorno de respostas bem-sucedidas:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID para identificação da mensagem
  • trackinId - String para rastrear o status da entrega

Início rápido

  1. Enviar mensagens - Comece a enviar mensagens em cascata
  2. Variáveis de mensagem - Use conteúdo dinâmico
  3. Tipos de mensagens - Explore os tipos de mensagens

Exemplo de solicitação

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "text": "Hello %name=1%, your order #%url=2% is ready!",
      "variables": [
        {
          "id": 1,
          "value": "John"
        },
        {
          "id": 2,
          "value": "12345"
        }
      ]
    }
  ]
}

Tratamento de erros

Códigos de status HTTP:

  • 200 OK - Solicitação bem-sucedida
  • 400 Bad Request - Formato de solicitação inválido
  • 401 Não Autorizado - Falha na autenticação
  • 429 Too Many Requests - Limite de taxa excedido
  • 500 Erro interno do servidor - Erro do servidor

Benefícios

Integração Única

Uma integração de API para todos os canais de mensagens – não há necessidade de integração com cada plataforma separadamente.

Roteamento Automático

O roteamento inteligente garante a entrega da mensagem através do melhor canal disponível para cada destinatário.

Otimização de custos

A Cascade tenta primeiro os canais mais baratos, voltando automaticamente para opções mais caras apenas quando necessário.

Taxas de entrega mais altas

Vários canais alternativos garantem que sua mensagem chegue ao destinatário mesmo se o canal principal falhar.

Próximas etapas