Fehlercodes

Bei der Interaktion mit der SMSBAT-API können Fehler auftreten. Wir verwenden herkömmliche HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen.

Allgemein: - Codes im Bereich „2xx“ zeigen einen Erfolg an. - Codes im Bereich „4xx“ weisen auf einen Fehler hin, der aufgrund der bereitgestellten Informationen fehlgeschlagen ist (z. B. wurde ein erforderlicher Parameter weggelassen, ein Nachrichtentyp ist ungültig usw.). - Codes im Bereich „5xx“ weisen auf einen Fehler bei unseren Servern hin.

HTTP-Statuscodes

Code	Status	Beschreibung
200	„OK“	Die Anfrage war erfolgreich.
400	„Ungültige Anfrage“	Die Anfrage war inakzeptabel, oft weil ein erforderlicher Parameter fehlte oder JSON fehlerhaft war.
401	„Unautorisiert“	Es wurde kein gültiger API-Schlüssel bereitgestellt oder die Authentifizierung ist fehlgeschlagen.
403	„Verboten“	Der API-Schlüssel verfügt nicht über die Berechtigung zum Ausführen der Anfrage, oder Ihr Konto ist gesperrt.
404	„Nicht gefunden“	Die angeforderte Ressource existiert nicht.
415	„Nicht unterstützter Medientyp“	Der „Content-Type“-Header fehlt oder ist nicht auf „application/json“ gesetzt.
422	Unverarbeitbare Entität	Die Anfrage war korrekt formatiert, enthielt jedoch semantische Fehler (z. B. ungültiges Telefonnummernformat).
429	„Zu viele Anfragen“	Zu viele Anfragen erreichen die API zu schnell. Wir empfehlen einen exponentiellen Backoff Ihrer Anfragen.
500, 502, 503, 504	Serverfehler	Bei SMSBAT ist ein Fehler aufgetreten.

Fehlerantwortformat

Wenn eine API-Anfrage zu einem Fehler führt, enthält der Antworttext ein JSON-Objekt mit weiteren Details zum Problem.

{
  "status": 400,
  "error": "Bad Request",
  "message": "Missing required field: 'messages'",
  "code": 1001
}

Geschäftslogik-Fehlercodes (interne Codes)

Zusätzlich zu den HTTP-Statuscodes geben wir möglicherweise einen bestimmten internen „Code“ zurück, der Ihnen hilft, den genauen Grund für den Fehler zu ermitteln.

Interner Code	Beschreibung	Vorgeschlagene Maßnahme
1001	„Ungültiges Anforderungsformat“	Stellen Sie sicher, dass Ihr Anfragetext gültiges JSON ist.
1002	„Erforderliches Feld fehlt“	Überprüfen Sie die Eigenschaft „message“ in der Antwort, um festzustellen, welches Feld fehlt.
1003	„Ungültige Telefonnummer“	Stellen Sie sicher, dass die Empfängernummer im E.164-Format vorliegt (z. B. „380501234567“).
1004	Nicht registrierter Alpha-Name	Der Parameter „from“ enthält einen Alphanamen, der für Ihr Konto nicht genehmigt wurde.
1005	„Unzureichendes Guthaben“	Ihr Konto verfügt nicht über genügend Guthaben, um die Messaging-Kampagne durchzuführen.
1006	„Ungültiger Nachrichtentyp“	Der Parameter „type“ muss einer der unterstützten Typen sein (z. B. „sms“, „viber_promo“).
1007	„Vorlage nicht gefunden“	Die angeforderte Viber/OTP-Vorlagen-ID ist ungültig oder nicht genehmigt.
1008	„Ungültige Karussellelemente“	Ein Viber-Karussell muss zwischen 2 und 5 Elemente enthalten.

[!TIP] Wenn Sie auf einen Fehlercode stoßen, der hier nicht aufgeführt ist, oder wenn Sie glauben, dass ein Fehler versehentlich zurückgegeben wurde, wenden Sie sich bitte an [email protected] und geben Sie die genaue Antwortnutzlast und die Header an.