Foutcodes

Bij interactie met de SMSBAT API kunt u fouten tegenkomen. We gebruiken conventionele HTTP-antwoordcodes om het succes of falen van een API-verzoek aan te geven.

Algemeen:

• Codes in het bereik 2xx duiden op succes.
• Codes in het bereik ‘4xx’ geven een fout aan die is mislukt op basis van de verstrekte informatie (bijvoorbeeld: een vereiste parameter is weggelaten, een berichttype is ongeldig, enz.).
• Codes in het bereik 5xx duiden op een fout met onze servers.

HTTP-statuscodes

Code	Staat	Beschrijving
200	Oké	Het verzoek was succesvol.
400	Slecht verzoek	Het verzoek was onaanvaardbaar, vaak vanwege het ontbreken van een vereiste parameter of een onjuist opgemaakte JSON.
401	Ongeautoriseerd	Er is geen geldige API-sleutel opgegeven of de authenticatie is mislukt.
403	Verboden	De API-sleutel heeft geen rechten om het verzoek uit te voeren, of uw account is opgeschort.
404	Niet gevonden	De aangevraagde bron bestaat niet.
415	Niet-ondersteund mediatype	De header ‘Content-Type’ ontbreekt of is niet ingesteld op ‘application/json’.
422	Onverwerkbare entiteit	Het verzoek was correct opgemaakt, maar bevatte semantische fouten (bijvoorbeeld een ongeldig telefoonnummerformaat).
429	Te veel verzoeken	Te veel verzoeken komen te snel in de API terecht. We raden een exponentieel uitstel van uw verzoeken aan.
500, 502, 503, 504	Serverfouten	Er is iets misgegaan aan het einde van SMSBAT.

Foutreactieformaat

Wanneer een API-verzoek resulteert in een fout, bevat de antwoordtekst een JSON-object met meer details over het probleem.

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

Bedrijfslogica-foutcodes (interne codes)

Naast HTTP-statuscodes kunnen we een specifieke interne ‘code’ retourneren om u te helpen de exacte reden voor de fout te identificeren.

Interne code	Beschrijving	Voorgestelde actie
1001	Ongeldig verzoekformaat	Zorg ervoor dat uw aanvraagtekst een geldige JSON is.
1002	Ontbrekend verplicht veld	Controleer de eigenschap message in het antwoord om te zien welk veld ontbreekt.
1003	Ongeldig telefoonnummer	Zorg ervoor dat het nummer van de ontvanger de E.164-indeling heeft (bijvoorbeeld ‘380501234567’).
1004	Niet-geregistreerde alfanaam	De parameter from bevat een alfanaam die niet is goedgekeurd voor uw account.
1005	Onvoldoende saldo	Er is onvoldoende saldo op uw account om de berichtencampagne te verwerken.
1006	Ongeldig berichttype	De parameter type moet een van de ondersteunde typen zijn (bijvoorbeeld sms, viber_promo).
1007	Sjabloon niet gevonden	De aangevraagde Viber/OTP-sjabloon-ID is ongeldig of niet goedgekeurd.
1008	Ongeldige carrouselitems	Een Viber-carrousel moet tussen de 2 en 5 items bevatten.

[!TIP] Als u een foutcode tegenkomt die hier niet wordt vermeld, of als u denkt dat er per ongeluk een fout is geretourneerd, neem dan contact op met [email protected] en geef de exacte responspayload en headers op.