Aller au contenu

API Cascade

L'API Cascade permet d'envoyer des messages sur plusieurs plates-formes avec une seule requête, en les acheminant automatiquement vers Telegram Bot, Viber Bot, Viber Business Messages, RCS et SMS.

URL de base

https://restapi.smsbat.com

Authentification

L'API Cascade utilise une authentification basée sur les en-têtes avec trois en-têtes d'authentification possibles :

Méthode 1 : clé 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éthode 2 : Jeton de robot Viber

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éthode 3 : clé du robot 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

Points de terminaison disponibles

Méthode Point de terminaison Descriptif
POSTER /api/CascadeMessage/send_message/async Envoi général de messages en cascade
POSTER /api/CascadeMessage/send_message/tg-viber/async Cascade prioritaire par télégramme

Comment ça marche

Avec une seule requête API, Cascade diffuse automatiquement votre message sur plusieurs canaux :

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

Le message est transmis via le premier canal disponible, avec retour automatique au canal suivant en cas d'échec de la transmission.

Principales fonctionnalités

Diffusion multicanal

Envoyez un message et touchez les utilisateurs sur n'importe quelle plateforme :

  • Bot de télégramme
  • Viber Bot
  • Messages professionnels Viber -RCS (Rich Communication Services) -SMS

Substitution de variables

Utilisez du contenu dynamique avec des espaces réservés variables :

  • %name=id% - Variables de texte
  • %url=id% - Variables d'URL
  • %short_url=id% - Variables d'URL raccourcies

Planification des messages

Planifiez des messages pour une livraison future :

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

Durée de vie (TTL)

Définir le délai d'expiration des messages :

{
  "ttl": 3600
}

Types de messages

L'API Cascade prend en charge :

  • Transactionnel - Confirmations de commande, notifications
  • Promo - Messages marketing et promotionnels
  • Enquêtes Viber - Enquêtes interactives
  • Appels Flash - Vérification du téléphone

Format de réponse

Les réponses positives reviennent :

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID pour l'identification du message
  • trackinId - Chaîne pour suivre l'état de livraison

Démarrage rapide

  1. Envoyer des messages - Commencez à envoyer des messages en cascade
  2. Variables du message - Utiliser du contenu dynamique
  3. Types de messages – Explorer les types de messages

Exemple de demande

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

Gestion des erreurs

Codes d'état HTTP :

  • 200 OK - Demande réussie
  • 400 Bad Request - Format de requête invalide
  • 401 Non autorisé - Échec de l'authentification
  • « 429 demandes trop nombreuses » - Limite de débit dépassée
  • 500 Erreur de serveur interne - Erreur de serveur

Avantages

Intégration unique

Une intégration API pour tous les canaux de messagerie : pas besoin d'intégrer chaque plate-forme séparément.

Routage automatique

Le routage intelligent garantit la livraison des messages via le meilleur canal disponible pour chaque destinataire.

Optimisation des coûts

Cascade essaie d'abord les chaînes les moins chères, et revient automatiquement aux options plus chères uniquement en cas de besoin.

Des taux de livraison plus élevés

Plusieurs canaux de secours garantissent que votre message parvient au destinataire même en cas de défaillance du canal principal.

Prochaines étapes