Envoi de code OTP personnalisé

Si vous souhaitez générer vous-même les codes de vérification au lieu de les faire générer par la plateforme EngageLab, vous pouvez appeler cette API.

Cette API est spécifiquement conçue pour envoyer des codes de vérification pré-générés et ne génère pas elle-même de codes de vérification. Après l'envoi d'un code de vérification, il n'est pas nécessaire d'appeler une API de vérification pour le valider.

Si vous souhaitez que la plateforme EngageLab génère les codes de vérification, vous pouvez appeler l'API EngageLab OTP Verification Code Delivery.

Point de terminaison

POST https://otp.api.engagelab.cc/v1/codes

Authentification

Utilisez l'authentification HTTP Basic en ajoutant Authorization à l'en-tête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

L'algorithme de génération de base64_auth_string ci-dessus est le suivant : base64(dev_key:dev_secret)

Exemple de requête

En-tête de requête

              
              POST /v1/codes HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Corps de la requête

              
              {
  "to": "+6591234567",
  "code": "398210",
  "template": {
    "id": "test-template-1",
    "language": "default",
    "params": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

            

Paramètres de requête

Un objet de requête est exprimé au format JSON ; l'en-tête de requête doit donc inclure Content-Type: application/json.

Description de params

1. Pour les champs de modèle prédéfinis tels que from_id, si la valeur du champ param_vars n'est pas fournie, le from_id prédéfini dans le modèle sera utilisé lors de l'envoi du message.
2. Si la valeur du champ param_vars est fournie, par exemple param_vars:{"from_id":"12345"}, le from_id du modèle sera remplacé par 12345 lors de l'envoi du message.
3. Les champs de variables personnalisées dans le contenu du modèle, créés lors de la création du modèle, reçoivent également des valeurs via param_vars. Par exemple, si le contenu du modèle est Hi {{name}}, your verify code is {{code}}, le paramètre d'affectation param_vars:{"name":"Bob"} est requis.

Paramètres de réponse

Réponse réussie

              
              {
  "message_id": "1725407449772531712",
  "send_channel": "sms"
}

            

Veuillez noter que la valeur send_channel renvoyée ne représente pas le canal final utilisé pour livrer le message à l'utilisateur ; elle représente uniquement le canal actuellement utilisé. Par exemple, si la stratégie du modèle est configurée de sorte qu'une livraison via le canal WhatsApp soit automatiquement retentée via le canal SMS en cas d'échec, la réponse de l'API renverra la valeur whatsapp. Après un certain temps, si un échec de livraison est détecté, le système enverra le message via le canal SMS.

Réponse d'échec

Le code d'état HTTP est 4xx ou 5xx, et le corps de la réponse contient les champs suivants :

              
              {
  "code": 5001,
  "message": "sms send fail"
}

            

Codes d'erreur