Кодове за грешки

Когато взаимодействате с SMSBAT API, може да срещнете грешки. Използваме конвенционални HTTP кодове за отговор, за да посочим успеха или неуспеха на API заявка.

Като цяло:

• Кодовете в диапазона 2xx показват успех.
• Кодовете в диапазона 4xx показват грешка, която е неуспешна предвид предоставената информация (напр. задължителен параметър е пропуснат, тип съобщение е невалиден и т.н.).
• Кодовете в диапазона 5xx показват грешка с нашите сървъри.

HTTP статус кодове

Код	Статус	Описание
200	OK	Заявката беше успешна.
400	Bad Request	Заявката беше неприемлива, често поради липсващ задължителен параметър или неправилно образуван JSON.
401	Unauthorized	Не е предоставен валиден API ключ или удостоверяването е неуспешно.
403	Forbidden	API ключът няма разрешения за изпълнение на заявката или акаунтът ви е спрян.
404	Not Found	Заявеният ресурс не съществува.
415	Unsupported Media Type	Заглавката Content-Type липсва или не е зададена на application/json.
422	Unprocessable Entity	Заявката беше форматирана правилно, но съдържаше семантични грешки (напр. невалиден формат на телефонен номер).
429	Too Many Requests	Твърде много заявки удрят API твърде бързо. Препоръчваме експоненциално забавяне на вашите заявки.
500, 502, 503, 504	Server Errors	Нещо се обърка от страна на SMSBAT.

Формат на отговора за грешка

Когато API заявка доведе до грешка, тялото на отговора съдържа JSON обект с повече подробности за проблема.

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

Кодове за грешки на бизнес логиката (вътрешни кодове)

В допълнение към HTTP кодовете за състояние, ние може да върнем конкретен вътрешен code, за да ви помогнем да идентифицирате точната причина за неуспеха.

Вътрешен код	Описание	Предложено действие
1001	Invalid Request Format	Уверете се, че тялото на вашата заявка е валиден JSON.
1002	Missing Required Field	Проверете свойството message в отговора, за да видите кое поле липсва.
1003	Invalid Phone Number	Уверете се, че номерът на получателя е във формат E.164 (напр. 380501234567).
1004	Unregistered Alpha Name	Параметърът from съдържа алфа име, което не е одобрено за вашия акаунт.
1005	Insufficient Balance	Вашият акаунт няма достатъчно средства за обработка на кампанията за съобщения.
1006	Invalid Message Type	Параметърът type трябва да е един от поддържаните типове (напр. sms, viber_promo).
1007	Template Not Found	Исканият Viber/OTP шаблон ID е невалиден или не е одобрен.
1008	Invalid Carousel Items	Viber Carousel трябва да съдържа между 2 и 5 елемента.

[!СЪВЕТ] Ако срещнете код за грешка, който не е посочен тук, или ако смятате, че грешка е върната по погрешка, моля, свържете се с help@smsbat.com и предоставете точния полезен товар и заглавки на отговора.