Coduri de eroare

Când interacționați cu API-ul SMSBAT, este posibil să întâmpinați erori. Folosim coduri de răspuns HTTP convenționale pentru a indica succesul sau eșecul unei solicitări API.

În general:

• Codurile din intervalul 2xx indică succesul.
• Codurile din intervalul 4xx indică o eroare care a eșuat având în vedere informațiile furnizate (de exemplu, un parametru obligatoriu a fost omis, un tip de mesaj este invalid etc.).
• Codurile din intervalul 5xx indică o eroare la serverele noastre.

Coduri de stare HTTP

Cod	Stare	Descriere
200	OK	Solicitarea a avut succes.
400	Cerere proastă	Solicitarea a fost inacceptabilă, adesea din cauza lipsei unui parametru obligatoriu sau a unui JSON incorect.
401	Neautorizat	Nu a fost furnizată nicio cheie API validă sau autentificarea a eșuat.
403	Interzis	Cheia API nu are permisiuni pentru a efectua solicitarea sau contul dvs. este suspendat.
404	Nu a fost găsit	Resursa solicitată nu există.
415	Tip media neacceptat	Antetul Content-Type lipsește sau nu este setat la application/json.
422	Entitate neprocesabilă	Solicitarea a fost formatată corect, dar conținea erori semantice (de exemplu, format nevalid de număr de telefon).
429	Prea multe solicitări	Prea multe solicitări ajung prea repede la API. Vă recomandăm o retragere exponențială a solicitărilor dvs.
500, 502, 503, 504	Erori de server	Ceva a mers prost la sfârșitul SMSBAT.

Format de răspuns la eroare

Când o solicitare API are ca rezultat o eroare, corpul răspunsului conține un obiect JSON cu mai multe detalii despre problemă.

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

Coduri de eroare pentru logica de afaceri (coduri interne)

Pe lângă codurile de stare HTTP, este posibil să returnăm un „cod” intern specific pentru a vă ajuta să identificați motivul exact al eșecului.

Cod intern	Descriere	Acțiune sugerată
1001	Format de solicitare nevalid	Asigurați-vă că corpul solicitării dvs. este JSON valid.
1002	Câmp obligatoriu lipsă	Verificați proprietatea mesaj din răspuns pentru a vedea ce câmp lipsește.
1003	Număr de telefon nevalid	Asigurați-vă că numărul destinatarului este în format E.164 (de exemplu, „380501234567”).
1004	Nume alfa neînregistrat	Parametrul from conține un nume alfa care nu a fost aprobat pentru contul dvs.
1005	Sold insuficient	Contul dvs. nu are suficiente fonduri pentru a procesa campania de mesagerie.
1006	Tip de mesaj nevalid	Parametrul type trebuie să fie unul dintre tipurile acceptate (de exemplu, sms, viber_promo).
1007	Șablon nu a fost găsit	ID-ul șablonului Viber/OTP solicitat este invalid sau nu este aprobat.
1008	Elemente de carusel nevalide	Un carusel Viber trebuie să conțină între 2 și 5 articole.

[!SFAT] Dacă întâmpinați un cod de eroare care nu este listat aici sau dacă credeți că o eroare a fost returnată din greșeală, vă rugăm să contactați [email protected] și să furnizați răspunsul exact și anteturile.