Envoi d'OTP

Cette API génère des codes de vérification via la plateforme EngageLab et les distribue selon la stratégie de canal spécifiée dans le modèle.

Si vous souhaitez générer vous-même les codes de vérification au lieu d'utiliser la plateforme EngageLab, vous pouvez appeler l'API EngageLab OTP Custom Verification Code Delivery.

Point de terminaison

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

Authentification

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

              
              Authorization: Basic ${base64_auth_string}

            

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

Exemple de requête

En-tête de requête

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

            

Corps de requête

              
              {
  "to": "+6591234567",
  "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.

Remarques sur params

1. Pour les champs prédéfinis dans le modèle, tels que from_id, si la valeur du champ param_vars n'est pas fournie, le from_id prédéfini du 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"}, alors le from_id du modèle sera remplacé par 12345 lors de l'envoi du message.
3. Par ailleurs, les champs de variables personnalisées dans le contenu du modèle créé lors de sa création sont également affectés via param_vars. Par exemple, si le contenu du modèle est Hi {{name}}, your verify code is {{code}}, alors 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"
}

            

Notez que la valeur send_channel renvoyée ne représente pas le canal final utilisé pour transmettre le message à l'utilisateur. Elle indique uniquement le canal actuellement utilisé. Par exemple, si la stratégie du modèle est configurée de sorte que l'envoi via le canal WhatsApp échoue puis soit automatiquement retenté via le canal SMS, la réponse de l'API renverra la valeur whatsapp. Après un certain temps, une fois l'échec de distribution détecté, le système enverra le message via le canal SMS.

Réponse d'échec

Le code de statut 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