Envoi de messages personnalisés

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

Endpoint

POST https://otp.api.engagelab.cc/v1/custom-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)

Format de la requête

En-têtes 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

L'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 de modèle prédéfinies telles que {{brand_name}}, {{ttl}} et {{pwa_url}}, vous n'avez pas besoin 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, vous devez transmettre la variable {{code}} ; sinon, une erreur sera renvoyée.
3. Si le contenu du modèle contient des champs de variables personnalisées définis lors de la création du modèle, attribuez-leur également des valeurs via params. Par exemple, pour le contenu de modèle Hi {{name}}, your verify code is {{code}}, vous devez attribuer le paramètre params: {"name":"Bob"}.

Exemples 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 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 distribuer le message à l'utilisateur. Elle indique uniquement le canal actuellement utilisé. Par exemple, si la stratégie configurée dans le modèle spécifie qu'en cas d'échec de la distribution via WhatsApp, une nouvelle tentative doit automatiquement être effectuée via le canal SMS, la réponse de l'API renverra whatsapp. Après détection de l'échec de distribution après un certain délai, le système enverra alors le message via le canal SMS.

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