Envoi de message personnalisé

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

Adresse d'appel

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

Authentification

Veuillez consulter Authentification pour savoir comment effectuer l'authentification de l'API.

Format de la requête

En-tête de requête

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

            

Corps de la requête

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

            

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 variables prédéfinies du modèle telles que {{brand_name}}, {{ttl}}, {{pwa_url}}, etc., il n'est pas nécessaire de les transmettre ; le système les remplace automatiquement par le contenu spécifié lors de la création du modèle ;
2. Si le type de modèle est un code de vérification, la variable {{code}} doit obligatoirement être transmise, sinon une erreur sera renvoyée ;
3. De même, pour les champs de variables personnalisées présents dans le contenu du modèle lors de sa création, leur valeur est également affectée via params. Par exemple, si le contenu du modèle est Hi {{name}}, your verify code is {{code}}, vous devez affecter le paramètre params:{"name":"Bob"}.
4. Variables spéciales du canal Email : pour le canal Email, vous pouvez remplacer dynamiquement l'objet de l'e-mail (subject), le nom de l'expéditeur (from_name), l'adresse e-mail de l'expéditeur (from_mail), etc., via params. Pour l'utilisation avancée détaillée, veuillez consulter Créer un modèle - Utilisation avancée des variables de modèle Email.

Exemple de requête

1. Envoyer un code de vérification personnalisé :

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

            

2. Envoyer un contenu de notification personnalisé :

              
              {
    "to": "+6591234567",
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Envoyer un contenu marketing personnalisé :

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

            

Paramètres de réponse

Réponse en cas de succès

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

            

Notez que la valeur send_channel renvoyée ne représente pas le canal final de livraison à l'utilisateur, mais uniquement le canal utilisé à ce stade ; par exemple, si la stratégie configurée dans le modèle prévoit qu'en cas d'échec de livraison sur le canal WhatsApp, un renvoi automatique soit effectué sur le canal SMS, l'interface renverra la valeur whatsapp. Une fois l'échec de livraison détecté après un certain délai, le système utilisera le canal SMS pour l'envoi.

Réponse en cas 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