API-Fehler und Antworten

Dieser Referenzartikel behandelt die verschiedenen Fehler und Server-Antworten, die bei der Verwendung der Braze API auftreten können, und wie Sie diese beheben können.

Server-Antworten

Wenn Ihre POST-Nutzlast von unseren Servern akzeptiert wurde, erhalten Sie bei erfolgreichen Nachrichten die folgende Antwort:

1
2
3
{
  "message" : "success"
}

Beachten Sie, dass „success“ lediglich bedeutet, dass die RESTful-API-Nutzlast korrekt erstellt und an unseren Push-Benachrichtigungsdienst, E-Mail-Dienst oder andere Messaging-Dienste übermittelt wurde. Dies bedeutet nicht, dass die Nachrichten tatsächlich zugestellt wurden, da zusätzliche Faktoren die Zustellung der Nachricht verhindern könnten (beispielsweise könnte ein Gerät offline sein, das Push-Token könnte von den Servern von Apple abgelehnt werden, oder Sie könnten eine unbekannte Nutzer-ID angegeben haben).

Bei Endpunkten wie /users/identify, die keine Nachrichten senden, bedeutet eine Erfolgsmeldung lediglich, dass Braze die Anfrage zur Verarbeitung erhalten hat. Wenn nach der Verarbeitung keine Übereinstimmung für den Alias gefunden wird, wird die Anfrage abgebrochen.

Wenn Ihre Nachricht erfolgreich ist, jedoch nicht schwerwiegende Fehler enthält, erhalten Sie die folgende Antwort:

1
2
3
{
  "message" : "success", "errors" : [<minor error message>]
}

Im Falle eines Erfolgs werden alle Nachrichten, die nicht von einem Fehler im errors-Array betroffen waren, weiterhin zugestellt. Wenn Ihre Nachricht einen schwerwiegenden Fehler enthält, erhalten Sie die folgende Antwort:

1
2
3
{
  "message" : <fatal error message>, "errors" : [<minor error message>]
}

Antworten für getrackte Sende-IDs

Analytics sind immer für Campaigns verfügbar. Darüber hinaus sind Analytics für eine bestimmte Instanz des Campaign-Versands verfügbar, wenn die Campaign als Broadcast gesendet wird. Wenn Tracking für eine bestimmte Campaign-Versandinstanz verfügbar ist, erhalten Sie die folgende Antwort:

1
2
3
{
  "message": "success", "send_id" : "example_send_id"
}

Die angegebene Sende-ID kann als Parameter für den Endpunkt /send/data_series verwendet werden, um sendespezifische Analytics abzurufen.

Fehler

Das Statuscode-Element einer Server-Antwort ist eine dreistellige Zahl, wobei die erste Ziffer des Codes die Klasse der Antwort definiert.

• Die Klasse 2XX des Statuscodes (nicht schwerwiegend) zeigt an, dass Ihre Anfrage erfolgreich empfangen, verstanden und akzeptiert wurde.
• Die Klasse 4XX des Statuscodes (schwerwiegend) weist auf einen Client-Fehler hin. In der Tabelle der schwerwiegenden Fehler finden Sie eine vollständige Liste der 4XX-Fehlercodes und Beschreibungen.
• Die Klasse 5XX des Statuscodes (schwerwiegend) weist auf einen Server-Fehler hin. Es gibt mehrere mögliche Ursachen – beispielsweise kann der Server, auf den Sie zugreifen möchten, die Anfrage nicht ausführen, der Server wird gerade gewartet und kann die Anfrage daher nicht ausführen, oder der Server hat ein hohes Verkehrsaufkommen. In diesem Fall empfehlen wir Ihnen, Ihre Anfrage mit exponentiellem Backoff zu wiederholen. Im Falle eines Vorfalls oder Ausfalls ist Braze nicht in der Lage, REST-API-Aufrufe, die während des Vorfallszeitraums fehlgeschlagen sind, erneut abzuspielen. Sie müssen alle Aufrufe, die während des Vorfallszeitraums fehlgeschlagen sind, selbst wiederholen.
  • Ein 502-Fehler ist ein Fehler, der auftritt, bevor die Anfrage den Zielserver erreicht.
  • Ein 503-Fehler bedeutet, dass die Anfrage den Zielserver zwar erreicht hat, wir die Anfrage aber nicht abschließen können, weil die Kapazität nicht ausreicht, ein Netzwerkproblem vorliegt oder Ähnliches.
  • Ein 504-Fehler zeigt an, dass ein Server keine Antwort von einem anderen vorgelagerten Server erhalten hat.

Schwerwiegende Fehler

Die folgenden Statuscodes und zugehörigen Fehlermeldungen werden zurückgegeben, wenn bei Ihrer Anfrage ein schwerwiegender Fehler auftritt.

Warnung

Alle folgenden Fehlercodes weisen darauf hin, dass keine Nachrichten gesendet werden.