Fehler-Codes

Die CheckYout API verwendet standardmässige HTTP-Statuscodes und gibt strukturierte JSON-Fehlermeldungen zurück.

Fehlerformat

Alle Fehlerantworten folgen diesem Format:

{
  "error": "Kurze Fehlerbeschreibung",
  "details": "Optionale zusätzliche Informationen"
}
FeldTypBeschreibung
errorstringKurze, maschinenlesbare Fehlerbeschreibung. Immer vorhanden.
detailsstringOptionale zusätzliche Informationen zur Fehlerursache.

HTTP-Statuscodes

CodeBedeutungTypische UrsacheBeispiel
200OKAnfrage erfolgreich verarbeitet{"success":true,"message_sid":"SM..."}
400Bad RequestFehlende Pflichtfelder oder ungültiges Format{"error":"Missing required fields: device_id, phone"}
400Bad RequestUngültiges Telefonnummernformat{"error":"Phone must be in E.164 format (starting with +)"}
401UnauthorizedFehlender oder ungültiger API-Key{"error":"Invalid or missing API key"}
404Not FoundGerät existiert nicht oder gehört nicht zum Account{"error":"Device not found or does not belong to your account"}
429Too Many RequestsRate-Limit überschrittenGeplant für v1.1
500Internal Server ErrorWhatsApp-Versand fehlgeschlagen{"error":"Failed to send WhatsApp","details":"..."}

Fehlerbehandlung

  • 4xx-Fehler: Prüfen Sie Ihre Anfrage — API-Key, Pflichtfelder, Telefonnummernformat, Device-Zuordnung.
  • 5xx-Fehler: Serverseitiges Problem. Versuchen Sie die Anfrage nach kurzer Wartezeit erneut.
  • Werten Sie immer den HTTP-Statuscode und das error-Feld aus.

Retry-Strategie

Wir empfehlen bei 5xx-Fehlern einen Retry mit exponentiellem Backoff (z.B. 1s, 5s, 30s) und maximal 3 Versuchen.

Nächster Schritt: Changelog