Fejlkoder
Når du interagerer med SMSBAT API, kan du støde på fejl. Vi bruger konventionelle HTTP-svarkoder til at indikere succes eller fiasko for en API-anmodning.
Generelt:
- Koder i
2xx-intervallet indikerer succes. - Koder i
4xx-intervallet angiver en fejl, der mislykkedes givet de angivne oplysninger (f.eks. blev en påkrævet parameter udeladt, en meddelelsestype er ugyldig osv.). - Koder i
5xx-intervallet indikerer en fejl med vores servere.
HTTP-statuskoder
| Kode | Status | Beskrivelse |
|---|---|---|
| 200 | OK | Anmodningen lykkedes. |
| 400 | Dårlig anmodning | Anmodningen var uacceptabel, ofte på grund af manglende en påkrævet parameter eller forkert udformet JSON. |
| 401 | Uautoriseret | Der er ikke angivet nogen gyldig API-nøgle, eller godkendelse mislykkedes. |
| 403 | Forbudt | API-nøglen har ikke tilladelser til at udføre anmodningen, eller din konto er suspenderet. |
| 404 | Ikke fundet | Den anmodede ressource findes ikke. |
| 415 | Ikke-understøttet medietype | Content-Type-headeren mangler eller er ikke indstillet til application/json. |
| 422 | Ubearbejdelig enhed | Anmodningen var formateret korrekt, men indeholdt semantiske fejl (f.eks. ugyldigt telefonnummerformat). |
| 429 | For mange anmodninger | For mange anmodninger rammer API’en for hurtigt. Vi anbefaler en eksponentiel backoff af dine anmodninger. |
| 500, 502, 503, 504 | Serverfejl | Noget gik galt i SMSBAT’s ende. |
Fejlsvarsformat
Når en API-anmodning resulterer i en fejl, indeholder svarteksten et JSON-objekt med flere detaljer om problemet.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Business Logic fejlkoder (interne koder)
Ud over HTTP-statuskoder returnerer vi muligvis en specifik intern kode for at hjælpe dig med at identificere den nøjagtige årsag til fejlen.
| Intern kode | Beskrivelse | Foreslået handling |
|---|---|---|
| 1001 | Ugyldigt anmodningsformat | Sørg for, at din anmodningstekst er gyldig JSON. |
| 1002 | Mangler påkrævet felt | Tjek egenskaben “meddelelse” i svaret for at se, hvilket felt der mangler. |
| 1003 | Ugyldigt telefonnummer | Sørg for, at modtagernummeret er i E.164-format (f.eks. “380501234567”). |
| 1004 | Uregistreret alfanavn | Parameteren “fra” indeholder et alfanavn, der ikke er blevet godkendt til din konto. |
| 1005 | Utilstrækkelig balance | Din konto har ikke penge nok til at behandle beskedkampagnen. |
| 1006 | Ugyldig meddelelsestype | Parameteren “type” skal være en af de understøttede typer (f.eks. “sms”, “viber_promo”). |
| 1007 | Skabelon ikke fundet | Det anmodede Viber/OTP-skabelon-id er ugyldigt eller ikke godkendt. |
| 1008 | Ugyldige karruselelementer | En Viber-karrusel skal indeholde mellem 2 og 5 genstande. |
[!TIP] Hvis du støder på en fejlkode, der ikke er angivet her, eller hvis du mener, at en fejl blev returneret ved en fejl, bedes du kontakte [email protected] og angive den nøjagtige nyttelast og overskrifter.