Felkoder

När du interagerar med SMSBAT API kan du stöta på fel. Vi använder konventionella HTTP-svarskoder för att indikera framgång eller misslyckande för en API-begäran.

I allmänhet:

• Koder i intervallet 2xx indikerar framgång.
• Koder i “4xx”-intervallet indikerar ett fel som misslyckades med den information som tillhandahålls (t.ex. en obligatorisk parameter har utelämnats, en meddelandetyp är ogiltig, etc.).
• Koder i 5xx-intervallet indikerar ett fel med våra servrar.

HTTP-statuskoder

Kod	Status	Beskrivning
200	OK	Begäran lyckades.
400	Dålig begäran	Begäran var oacceptabel, ofta på grund av att en obligatorisk parameter saknas eller på felaktigt format JSON.
401	Obehörig	Ingen giltig API-nyckel har angetts, eller så misslyckades autentiseringen.
403	Förbjuden	API-nyckeln har inte behörighet att utföra begäran, eller så är ditt konto avstängt.
404	Not Found	Den begärda resursen finns inte.
415	Medietyp som inte stöds	Rubriken “Content-Type” saknas eller är inte inställd på “application/json”.
422	Obearbetbar enhet	Begäran var korrekt formaterad men innehöll semantiska fel (t.ex. ogiltigt telefonnummerformat).
429	För många förfrågningar	För många förfrågningar träffar API:et för snabbt. Vi rekommenderar en exponentiell backoff av dina förfrågningar.
500, 502, 503, 504	Serverfel	Något gick fel i slutet av SMSBAT.

Felsvarsformat

När en API-begäran resulterar i ett fel innehåller svarstexten ett JSON-objekt med mer information om problemet.

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

Business Logic-felkoder (interna koder)

Förutom HTTP-statuskoder kan vi returnera en specifik intern “kod” för att hjälpa dig att identifiera den exakta orsaken till felet.

Intern kod	Beskrivning	Föreslagen åtgärd
1001	Ogiltigt förfrågningsformat	Se till att din begäran är giltig JSON.
1002	”Obligatoriskt fält saknas”	Kontrollera egenskapen “meddelande” i svaret för att se vilket fält som saknas.
1003	Ogiltigt telefonnummer	Se till att mottagarnumret är i E.164-format (t.ex. “380501234567”).
1004	Oregistrerat alfanamn	Parametern “från” innehåller ett alfanamn som inte har godkänts för ditt konto.
1005	Otillräckligt saldo	Ditt konto har inte tillräckligt med pengar för att bearbeta meddelandekampanjen.
1006	Ogiltig meddelandetyp	Parametern “type” måste vara en av de typer som stöds (t.ex. “sms”, “viber_promo”).
1007	Mall hittades inte	Det begärda Viber/OTP-mall-ID:t är ogiltigt eller inte godkänt.
1008	Ogiltiga karusellartiklar	En Viber-karusell måste innehålla mellan 2 och 5 föremål.

[!TIPS] Om du stöter på en felkod som inte finns med här, eller om du tror att ett fel returnerades av misstag, kontakta [email protected] och ange den exakta nyttolasten och rubrikerna.