Zustellung benutzerdefinierter Nachrichten

Wenn Sie auf der OTP-Plattform benutzerdefinierte Vorlageninhalte erstellt haben, rufen Sie diese API auf, um benutzerdefinierte Nachrichteninhalte zu senden.

Endpoint

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

Authentifizierung

Verwenden Sie zur Authentifizierung HTTP Basic Authentication und fügen Sie Authorization dem HTTP-Header hinzu:

              
              Authorization: Basic ${base64_auth_string}

            

Der Algorithmus zur Generierung von base64_auth_string lautet: 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": "+6591234567",
  "template": {
    "id": "test-template-1",
    "params": {
      "code": "codevalue",
      "var1": "value1"
    }
  }
}

            

Anfrageparameter

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

Hinweise zu params

1. Für vordefinierte Vorlagenvariablen wie {{brand_name}}, {{ttl}} und {{pwa_url}} müssen Sie keine Werte übergeben. Das System ersetzt sie automatisch durch die Inhalte, die beim Erstellen der Vorlage festgelegt wurden.
2. Wenn der Vorlagentyp ein Verifizierungscode ist, müssen Sie die Variable {{code}} übergeben, andernfalls wird ein Fehler zurückgegeben.
3. Wenn der Vorlageninhalt benutzerdefinierte Variablenfelder enthält, die beim Erstellen der Vorlage definiert wurden, weisen Sie ihnen ebenfalls über params Werte zu. Für den Vorlageninhalt Hi {{name}}, your verify code is {{code}} müssen Sie beispielsweise den Parameter params: {"name":"Bob"} zuweisen.

Anfragebeispiele

1. Einen benutzerdefinierten Verifizierungscode senden

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

            

2. Benutzerdefinierte Benachrichtigungsinhalte senden

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

            

3. Benutzerdefinierte Marketinginhalte senden

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

            

Antwortparameter

Erfolgreiche Antwort

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

            

Beachten Sie, dass der zurückgegebene Wert von send_channel nicht den endgültigen Kanal darstellt, der für die Zustellung der Nachricht an den Benutzer verwendet wird. Er gibt nur den aktuell verwendeten Kanal an. Wenn beispielsweise die in der Vorlage konfigurierte Strategie festlegt, dass bei einer fehlgeschlagenen WhatsApp-Zustellung automatisch eine erneute Zustellung über den SMS-Kanal erfolgen soll, gibt die API-Antwort whatsapp zurück. Nachdem nach einer bestimmten Zeit ein Zustellungsfehler erkannt wurde, sendet das System dann über den SMS-Kanal.

Fehlgeschlagene Antwort

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

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

            

Fehlercodes