Custom Messages Delivery

Si vous avez créé un contenu de modèle personnalisé sur la plateforme OTP, utilisez cette API pour envoyer un contenu de message personnalisé.

Point de terminaison de l'API

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

Authentification

L'authentification HTTP Basic est utilisée pour la vérification. Ajoutez l'en-tête Authorization dans la requête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

Le base64_auth_string est généré selon l'algorithme suivant : base64(dev_key:dev_secret)

Format de la requête

En-têtes de la requête

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

            

Corps de la requête

              
              {
    "to": "+8618701235678", 
    "template":{
      "id":"test-template-1",
      "params": {
        "code": "codevalue",
        "var1":"value1"
        }
    }
}

            

Paramètres de la requête

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

Notes sur params :

Pour les variables prédéfinies du modèle telles que {{brand_name}}, {{ttl}} et {{pwa_url}}, aucune valeur n'a besoin d'être transmise — le système les remplacera automatiquement par le contenu spécifié lors de la création du modèle.

Si le type de modèle est un code de vérification, la variable {{code}} doit être transmise ; sinon, une erreur se produira.

Pour les variables personnalisées définies dans le contenu du modèle, attribuez des valeurs via params. Par exemple, si le contenu du modèle est Bonjour {{name}}, votre code de vérification est {{code}}, le paramètre params:{"name":"Bob"} doit être transmis.

Exemples de requêtes

1. Envoi d'un code de vérification personnalisé :

              
              {
    "to": "+8618701235678", 
    "template":{
      "id":"code-template",
      "params": {
        "code": "123456"        
        }
    }
}

            

2. Envoi d'une notification personnalisée :

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Envoi d'un contenu marketing personnalisé :

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

Paramètres de réponse

Réponse réussie

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

            

Remarque : La valeur send_channel retournée ne représente pas le canal final de livraison à l'utilisateur, seulement le canal utilisé à l'étape actuelle. Par exemple, si la stratégie du modèle est configurée pour basculer vers le SMS après un échec de livraison WhatsApp, l'API retournera initialement whatsapp. En cas d'échec, le système basculera automatiquement vers le SMS.

Réponse en cas d'échec

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

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