Custom OTP Code Delivery - Secure Transmission and Best Practices

Si vous préférez générer vous-même le code de vérification au lieu d'utiliser la plateforme EngageLab, vous pouvez appeler cette API.

Cette API est spécifiquement conçue pour l'envoi de codes de vérification pré-générés et ne générera pas elle-même les codes. Après l'envoi du code de vérification, il n'est pas nécessaire d'appeler l'API de vérification pour la validation.

Si vous souhaitez que la plateforme EngageLab génère le code de vérification, vous pouvez appeler l'API d'envoi OTP d'EngageLab.

Endpoint

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

Authentification

Utilisez l'authentification HTTP Basic pour la vérification. Ajoutez une autorisation dans l'en-tête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

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

Exemple de requête

En-tête de la requête

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

            

Corps de la requête

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

            

Paramètres de la requête

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

Remarques sur params

1. Pour les modèles avec des champs prédéfinis comme from_id, si la valeur du champ param_vars n'est pas transmise, le message utilisera le from_id prédéfini du modèle lors de l'envoi ;
2. Si les valeurs du champ param_vars sont transmises, comme param_vars:{"from_id":"12345"}, alors lors de l'envoi, le from_id du modèle sera remplacé par 12345 ;
3. De même, pour les champs de variables personnalisées créés dans le contenu du modèle, attribuez des valeurs via param_vars, ex. pour un contenu de modèle Hi {{name}}, votre code de vérification est {{code}}, attribuez les paramètres avec param_vars:{"name":"Bob"}

Paramètres de la réponse

Réponse en cas de succès

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

            

Remarque : la valeur send_channel retournée ne représente pas le canal final de diffusion à l'utilisateur, mais uniquement le canal de la phase en cours. Par exemple, si la stratégie du modèle est configurée pour basculer de WhatsApp à SMS en cas d'échec de livraison, l'API retournera initialement whatsapp, puis, si un échec de livraison est détecté, le système utilisera le canal SMS pour l'envoi.

Réponse en cas d'échec

Code de statut HTTP 4xx ou 5xx, le corps de la réponse inclut les champs suivants :

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

            

Codes d'erreur