HTTPS API v2 / Komunikaty ogólne
W przypadku braku określenia akcji, zablokowanego konta klienta lub podaniu błędnych danych klienta, SerwerSMS.pl wygeneruje dokument w formacie JSON lub XML z informacją na temat błędu, który wystąpił. Przykładowo w przypadku podania niewłaściwego loginu lub hasła klient zobaczy następujący komunikat:
{
"error":
{
"code":1001,
"type":"InvalidUser",
"message":"Nieprawidłowy login lub hasło"
}
}
Jeśli nie zostanie określona żadna akcja do wykonania, system wyświetli komunikat:
{
"error":
{
"code":1000,
"type":"InvalidAction",
"message":"Nie określono akcji do wykonania"
}
}
Podgląd komunikatu błędu można sprawdzić za pomocą akcji:
error/[code]
przykład:
https://api2.serwersms.pl/error/1000
odpowiedź:
{
"error":
{
"code":1000,
"type":"InvalidAction",
"message":"Nie określono akcji do wykonania"
}
}
Lista kodów błędów zwracanych przez API
Poniżej znajduje się tabela z kodami oraz przyporządkowanymi do nich opisami tekstowymi.
| Kod | Typ | Opis |
|---|---|---|
| Ogólne | ||
| 1000 | InvalidAction | Nie określono akcji do wykonania |
| 1001 | InvalidUser | Nieprawidłowy login lub hasło |
| 1002 | InvalidRole | Użytkownik nie ma uprawnień do korzystania z API (jeśli korzystasz z loginu konta głównego, utwórz użytkownika API lub wyraź zgodę na użycie loginu konta głównego przy komunikacji przez API). |
| 1003 | InvalidIP | Nieautoryzowany adres IP |
| 1004 | InvalidID | Nieprawidłowy parametr ID |
| 1005 | InvalidRole | Brak uprawnień |
| 1006 | InvalidData | Niepoprawny format danych |
| 1007 | InvalidRole | Konto nie jest w pełni aktywne |
| 1008 | InvalidRole | Użytkownik nie ma uprawnień do podglądu numerów |
| 1009 | InvalidIP | Zablokowany adres IP |
| 1010 | SystemError | System chwilowo niedostepny |
| 1011 | InvalidToken | Token API uległ przedawnieniu |
| 1012 | InvalidToken | Nieprawidłowy token API |
| 2000 | ValidationRequiredError | Brak wymaganych parametrów |
| 2001 | ValidationPhoneError | Nieprawidłowy numer telefonu |
| 2002 | ValidationCodeError | Nieprawidłowy kod błędu |
| Wiadomości | ||
| 3000 | SendError | Wyczerpano limit dostępnych wiadomości SMS ECO+ |
| 3001 | SendError | Brak uprawnień do wysyłania wiadomości SMS ECO+ |
| 3002 | SendError | Wyczerpano limit dostępnych wiadomości SMS FULL |
| 3003 | SendError | Brak uprawnień do wysyłania wiadomości SMS FULL |
| 3004 | SendError | Wyczerpano limit dostępnych wiadomości MMS |
| 3005 | SendError | Brak uprawnień do wysyłania wiadomości MMS |
| 3006 | SendError | Wyczerpano limit dostępnych wiadomości VOICE |
| 3007 | SendError | Brak uprawnień do wysyłania wiadomości VOICE |
| 3008 | SendError | Brak uprawnień do wysyłania wiadomości typu Flash SMS |
| 3009 | SendError | Brak uprawnień do wysyłania wiadomości SMS |
| 3100 | SendError | Wysyłanie wiadomości SMS zostało zablokowane |
| 3101 | SendError | Wiadomość jest pusta |
| 3102 | SendError | Wiadomość przekroczyła dozwoloną ilość znaków |
| 3103 | SendError | Błędny numer odbiorcy |
| 3104 | SendError | Nie podano numerów telefonów |
| 3105 | SendError | Niepoprawna treść wiadomości |
| 3106 | SendError | Nie można użyć tej nazwy nadawcy |
| 3107 | SendError | Nie posiadasz uprawnień do wysyłania wiadomości spersonalizowanych |
| 3108 | SendError | Nieprawidłowa godzina wysyłki |
| 3109 | SendError | Nieprawidłowy plik |
| 3110 | SendError | Zbyt duża ilość wiadomości do przesłania, maksymalna ilość to 100 000 SMS w jednym zgłoszeniu |
| 3111 | SendError | Błąd unikalności |
| 3200 | SendError | Niepoprawne znaki w uniqe_id |
| 3201 | SendError | Przesłane unique_id nie są unikalne |
| 3202 | SendError | Niezgodna ilość spersonalizowanych i uniqe_id |
| 3330 | MessageError | Brak wiadomości |
| 3331 | MessageError | Zbyt duża liczba rekordów do wyświetlenia. |
| Pliki | ||
| 4000 | FileError | Plik jest zbyt duży |
| 4001 | FileError | Plik nie istnieje |
| 4002 | FileInvalid | Nieprawidłowy plik |
| Numer telefonu/HLR | ||
| 4100 | PhoneError | Błąd połączenia |
| 4101 | PhoneError | Niepoprawny numer |
| 4102 | PhoneError | Brak uprawnień do HLR |
| 4103 | PhoneError | Wyczerpano limit dostępnych zapytań HLR |
| 4104 | PhoneError | Blokada konta |
| 4105 | PhoneError | Trwa oczekiwanie na odpowiedź |
| 4106 | PhoneError | Nieprawidłowy identyfikator |
| Premium | ||
| 4200 | PremiumError | Błąd wysyłki |
| 4201 | PremiumError | Nieprawidłowe dane |
| Konto | ||
| 4300 | AccountError | Brak loginu |
| 4301 | AccountError | Brak hasła |
| 4302 | AccountError | Brak numeru telefonu |
| 4303 | AccountError | Brak adresu e-mail |
| 4304 | AccountError | Brak imienia |
| 4305 | AccountError | Brak nazwiska |
| 4306 | AccountError | Brak nazwy firmy |
| 4307 | AccountError | Nieprawidłowy numer |
| 4308 | AccountError | Nieprawidłowy adres e-mail |
| 4309 | AccountError | Zbyt krótki login |
| 4310 | AccountError | Nieprawidłowy login |
| 4311 | AccountError | Nieprawidłowa firma |
| 4312 | AccountError | Login istnieje |
| 4313 | AccountError | Błąd rejestracji |
| 4320 | AccountError | Nie podano aktualnego hasła |
| 4321 | AccountError | Aktualne hasło jest nieprawidłowe |
| 4322 | AccountError | Nie podano nowego hasła |
| 4323 | AccountError | Wprowadzone nowe hasła nie są identyczne |
| 4324 | AccountError | Nie podano loginu |
| 4325 | AccountError | Nieprawidłowy login |
| Nazwy nadawcy | ||
| 4400 | SenderExists | Nazwa nadawcy już istnieje |
| 4401 | SenderError | Brak możliwości dodania numeru jako nazwę nadawcy |
| 4402 | SenderInvalid | Nieprawidłowa nazwa nadawcy |
| 4403 | SenderError | Nieprawidłowy numer |
| 4404 | SenderError | Nieprawidłowy kod lub numer |
| 4405 | SenderError | Numer był już aktywny |
| 4406 | SenderError | Konto demo nie posiada uprawnień do tworzenia nowych nazw |
| 4407 | SenderError | W ramach darmowego pakietu testowego możliwe jest utworzenie jednego własnego nadpisu |
| Subkonta | ||
| 4500 | SubaccountError | Brak uprawnień do działu użytkownicy |
| 4501 | SubaccountError | Subkonto nie może tworzyć subkont |
| 4502 | SubaccountError | Login zajęty |
| 4503 | SubaccountError | Brak szablonu uprawnień |
| 4504 | SubaccountError | Nieprawidłowy login lub hasło |
| Czarna lista | ||
| 4600 | BlacklistError | Brak operacji do wykonania |
| 4601 | BlacklistPhoneExists | Numer istnieje już na liście |
| 4602 | BlacklistError | Nie znaleziono podanego numeru |