Custom Messages Delivery

Wenn Sie auf der OTP-Plattform eigene Vorlageninhalte erstellt haben, können Sie diese API nutzen, um individuelle Nachrichteninhalte zu versenden.

API-Endpunkt

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

Authentifizierung

Zur Authentifizierung wird HTTP Basic Authentication verwendet. Fügen Sie den Authorization-Header in die HTTP-Anfrage ein:

              
              Authorization: Basic ${base64_auth_string}

            

Der base64_auth_string wird nach folgendem Schema generiert: base64(dev_key:dev_secret)

Anfrageformat

Anfrage-Header

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

            

Anfrage-Body

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

            

Anfrageparameter

Das Anfrageobjekt wird im JSON-Format übermittelt; daher muss der Header Content-Type: application/json enthalten sein.

Hinweise zu params:

Für vordefinierte Variablen wie {{brand_name}}, {{ttl}} und {{pwa_url}} müssen keine Werte übergeben werden – das System ersetzt diese automatisch durch die bei der Vorlagenerstellung festgelegten Inhalte.

Handelt es sich um einen Verifizierungscode, muss die Variable {{code}} übergeben werden, andernfalls tritt ein Fehler auf.

Für benutzerdefinierte Variablen, die im Vorlageninhalt definiert wurden, müssen Werte über params zugewiesen werden. Beispiel: Ist der Vorlageninhalt „Hi {{name}}, your verify code is {{code}}“, sollte params:{"name":"Bob"} übergeben werden.

Anfragebeispiele

1. Versand eines individuellen Verifizierungscodes:

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

            

2. Versand einer individuellen Benachrichtigung:

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

            

3. Versand individueller Marketinginhalte:

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

            

Antwortparameter

Erfolgreiche Antwort

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

            

Hinweis: Der zurückgegebene Wert von send_channel gibt nicht den endgültigen Zustellkanal an, sondern nur den aktuell verwendeten Kanal. Ist beispielsweise eine Strategie konfiguriert, bei der nach einem WhatsApp-Fehlschlag automatisch auf SMS umgestellt wird, gibt die API zunächst whatsapp zurück. Bei Fehlschlag erfolgt die Zustellung automatisch per SMS.

Fehlgeschlagene Antwort

Der HTTP-Statuscode ist 4xx oder 5xx; der Antwortkörper enthält folgende Felder:

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