Saltar a contenido

API en cascada

La API Cascade permite enviar mensajes a través de múltiples plataformas con una sola solicitud, enrutando automáticamente a Telegram Bot, Viber Bot, Viber Business Messages, RCS y SMS.

URL base

https://restapi.smsbat.com

Autenticación

Cascade API utiliza autenticación basada en encabezados con tres encabezados de autenticación posibles:

Método 1: clave 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 de 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: Clave del bot de Telegram

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

Puntos finales disponibles

Método Punto final Descripción
PUBLICAR /api/CascadeMessage/send_message/async Envío general de mensajes en cascada
PUBLICAR /api/CascadeMessage/send_message/tg-viber/async Cascada priorizada por Telegram

Cómo funciona

Con una única solicitud de API, Cascade envía automáticamente su mensaje a través de múltiples canales:

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

El mensaje se entrega a través del primer canal disponible, con retorno automático al siguiente canal si falla la entrega.

Características clave

Entrega multicanal

Envíe un mensaje y llegue a los usuarios en cualquier plataforma:

  • Bot de Telegrama
  • Viberbot
  • Mensajes comerciales de Viber
  • RCS (Servicios de comunicación enriquecidos) -SMS

Sustitución de variables

Utilice contenido dinámico con marcadores de posición variables:

  • %nombre=id% - Variables de texto
  • %url=id% - variables de URL
  • %short_url=id% - Variables de URL acortadas

Programación de mensajes

Programe mensajes para entrega futura:

{
  "scheduledTime": "2025-01-24T12:00:00Z"
}

Tiempo de vida (TTL)

Establecer tiempo de vencimiento para mensajes:

{
  "ttl": 3600
}

Tipos de mensajes

La API en cascada admite:

  • Transaccional - Confirmaciones de pedidos, notificaciones
  • Promo - Mensajes promocionales y de marketing.
  • Encuestas de Viber - Encuestas interactivas
  • Llamadas flash - Verificación telefónica

Formato de respuesta

Vuelven las respuestas exitosas:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID para identificación de mensajes
  • trackinId: cadena para rastrear el estado de entrega

Inicio rápido

  1. Enviar mensajes: comienza a enviar mensajes en cascada
  2. Variables del mensaje: utilizar contenido dinámico
  3. Tipos de mensajes - Explorar tipos de mensajes

Ejemplo de solicitud

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

Manejo de errores

Códigos de estado HTTP:

  • 200 OK - Solicitud exitosa
  • 400 Solicitud incorrecta - Formato de solicitud no válido
  • 401 No autorizado - Error de autenticación
  • 429 Demasiadas solicitudes - Límite de tasa excedido
  • 500 Error interno del servidor - Error del servidor

Beneficios

Integración única

Una integración de API para todos los canales de mensajería: no es necesario integrar cada plataforma por separado.

Enrutamiento automático

El enrutamiento inteligente garantiza la entrega de mensajes a través del mejor canal disponible para cada destinatario.

Optimización de costos

Cascade prueba primero los canales más baratos y recurre automáticamente a opciones más caras sólo cuando es necesario.

Tasas de entrega más altas

Múltiples canales alternativos garantizan que su mensaje llegue al destinatario incluso si el canal principal falla.

Próximos pasos