Benutzerdefinierte Nachricht senden

Wenn Sie auf der OTP-Plattform benutzerdefinierte Vorlageninhalte erstellt haben, können Sie diese Schnittstelle aufrufen, um benutzerdefinierte Nachrichteninhalte zu senden.

Anfrage-URL

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

Authentifizierung

Bitte lesen Sie Authentifizierung, um zu erfahren, wie Sie die API-Authentifizierung durchführen.

Anfrageformat

Anfrage-Header

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

            

Anfragetext

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

            

Anfrageparameter

Ein Anfrageobjekt wird im JSON-Format ausgedrückt, daher muss der Anfrage-Header Content-Type: application/json enthalten.

Hinweise zu params

1. Voreingestellte Vorlagenvariablen wie {{brand_name}}, {{ttl}}, {{pwa_url}} usw. müssen nicht übergeben werden; das System ersetzt sie automatisch durch den beim Erstellen der Vorlage angegebenen Inhalt;
2. Wenn der Vorlagentyp ein Verifizierungscode ist, muss die Variable {{code}} übergeben werden, andernfalls wird ein Fehler gemeldet;
3. Gleichzeitig werden auch benutzerdefinierte Variablenfelder im Vorlageninhalt, die beim Erstellen der Vorlage festgelegt wurden, über params mit Werten belegt. Wenn der Vorlageninhalt beispielsweise Hi {{name}}, your verify code is {{code}} lautet, müssen Sie den Parameter params:{"name":"Bob"} zuweisen.
4. Spezielle Variablen des Email-Kanals: Für den Email-Kanal können Sie über params den E-Mail-Betreff (subject), den Absendernamen (from_name), die Absender-E-Mail (from_mail) usw. dynamisch überschreiben. Ausführliche Hinweise zur erweiterten Verwendung finden Sie unter Vorlage erstellen – Erweiterte Verwendung von E-Mail-Vorlagenvariablen.

Anfragebeispiel

1. Benutzerdefinierten Verifizierungscode senden:

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

            

2. Benutzerdefinierten Benachrichtigungsinhalt senden:

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

            

3. Benutzerdefinierten Marketinginhalt senden:

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

            

Antwortparameter

Erfolgsantwort

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

            

Beachten Sie, dass der zurückgegebene Wert send_channel nicht den endgültig an den Benutzer zugestellten Kanal darstellt, sondern nur den in dieser Phase verwendeten Kanal; wenn zum Beispiel die in der Vorlage konfigurierte Strategie vorsieht, dass nach einem fehlgeschlagenen WhatsApp-Versand automatisch auf den SMS-Kanal zurückgegriffen wird, gibt die Schnittstelle den Wert whatsapp zurück. Nachdem das System den Zustellfehler nach einer gewissen Zeit erkannt hat, verwendet es den SMS-Kanal zum Senden.

Fehlerantwort

Der HTTP-Statuscode ist 4xx oder 5xx, und der Antworttext enthält die folgenden Felder:

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

            

Fehlercodes