Kody błędów
Podczas interakcji z API SMSBAT mogą wystąpić błędy. Używamy konwencjonalnych kodów odpowiedzi HTTP, aby wskazać powodzenie lub niepowodzenie żądania API.
Ogólnie:
- Kody z zakresu „2xx” oznaczają sukces.
- Kody z zakresu „4xx” wskazują błąd, który nie powiódł się, biorąc pod uwagę dostarczone informacje (np. pominięto wymagany parametr, nieprawidłowy typ komunikatu itp.).
- Kody z zakresu „5xx” wskazują błąd na naszych serwerach.
Kody stanu HTTP
| Kod | Stan | Opis |
|---|---|---|
| 200 | OK | Żądanie zostało zrealizowane. |
| 400 | Złe żądanie | Żądanie było nieakceptowalne, często z powodu braku wymaganego parametru lub nieprawidłowego formatu JSON. |
| 401 | Nieautoryzowane | Nie podano prawidłowego klucza API lub uwierzytelnianie nie powiodło się. |
| 403 | „Zabronione” | Klucz API nie ma uprawnień do wykonania żądania lub Twoje konto zostało zawieszone. |
| 404 | Nie znaleziono | Żądany zasób nie istnieje. |
| 415 | Nieobsługiwany typ multimediów | Brak nagłówka „Content-Type” lub nie jest on ustawiony na „application/json”. |
| 422 | Etencja nieprzetwarzalna | Żądanie zostało poprawnie sformatowane, ale zawierało błędy semantyczne (np. nieprawidłowy format numeru telefonu). |
| 429 | „Zbyt wiele żądań” | Zbyt wiele żądań zbyt szybko trafia do interfejsu API. Zalecamy wykładnicze wycofywanie żądań. |
| 500, 502, 503, 504 | Błędy serwera | Coś poszło nie tak po stronie SMSBAT. |
Format odpowiedzi na błąd
Gdy żądanie API kończy się błędem, treść odpowiedzi zawiera obiekt JSON zawierający więcej szczegółów na temat problemu.
KOD_BLOKU_0
Kody błędów logiki biznesowej (kody wewnętrzne)
Oprócz kodów stanu HTTP możemy zwrócić określony wewnętrzny „kod”, który pomoże Ci zidentyfikować dokładną przyczynę niepowodzenia.
| Kod wewnętrzny | Opis | Sugerowane działanie |
|---|---|---|
| 1001 | Nieprawidłowy format żądania | Upewnij się, że treść żądania jest prawidłowym formatem JSON. |
| 1002 | Brak wymaganego pola | Sprawdź właściwość „message” w odpowiedzi, aby zobaczyć, którego pola brakuje. |
| 1003 | Nieprawidłowy numer telefonu | Upewnij się, że numer odbiorcy jest w formacie E.164 (np. „380501234567”). |
| 1004 | Niezarejestrowana nazwa alfa | Parametr „from” zawiera nazwę alfa, która nie została zatwierdzona dla Twojego konta. |
| 1005 | „Niewystarczająca równowaga” | Na Twoim koncie nie ma wystarczających środków, aby przetworzyć kampanię wiadomości. |
| 1006 | Nieprawidłowy typ wiadomości | Parametr type musi należeć do jednego z obsługiwanych typów (np. sms, viber_promo). |
| 1007 | Nie znaleziono szablonu | Żądany identyfikator szablonu Viber/OTP jest nieprawidłowy lub niezatwierdzony. |
| 1008 | Nieprawidłowe elementy karuzeli | Karuzela Viber musi zawierać od 2 do 5 elementów. |
[!WSKAZÓWKA] Jeśli napotkasz kod błędu, który nie jest tutaj wymieniony, lub jeśli uważasz, że błąd został zwrócony przez pomyłkę, skontaktuj się z [email protected] i podaj dokładny ładunek odpowiedzi oraz nagłówki.