Коди помилок

Під час взаємодії з API SMSBAT ви можете зіткнутися з помилками. Ми використовуємо звичайні коди відповіді HTTP, щоб вказати успішність або невдачу запиту API.

Загалом:

• Коди в діапазоні “2xx” вказують на успіх.
• Коди в діапазоні 4xx вказують на помилку, яка виникла невдало, враховуючи надану інформацію (наприклад, необхідний параметр був пропущений, тип повідомлення недійсний тощо).
• Коди в діапазоні 5xx вказують на помилку наших серверів.

Коди стану HTTP

Код	Статус	Опис
200	ОК	Запит був успішним.
400	Поганий запит	Запит був неприйнятним, часто через відсутність необхідного параметра або неправильний формат JSON.
401	Неавторизований	Не надано дійсного ключа API або помилка автентифікації.
403	Заборонено	Ключ API не має дозволу на виконання запиту, або ваш обліковий запис призупинено.
404	Не знайдено	Потрібний ресурс не існує.
415	Непідтримуваний тип носія	Заголовок Content-Type відсутній або не встановлено значення application/json.
422	Необроблювана сутність	Запит був відформатований правильно, але містив семантичні помилки (наприклад, недійсний формат номера телефону).
429	Занадто багато запитів	Занадто багато запитів потрапляють на API занадто швидко. Ми рекомендуємо експоненціальний відкат ваших запитів.
500, 502, 503, 504	Помилки сервера	Щось пішло не так у SMSBAT.

Формат відповіді на помилку

Коли запит API призводить до помилки, тіло відповіді містить об’єкт JSON з докладнішою інформацією про проблему.

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

Коди помилок бізнес-логіки (внутрішні коди)

Окрім кодів стану HTTP, ми можемо повернути певний внутрішній «код», щоб допомогти вам визначити точну причину збою.

Внутрішній код	Опис	Пропонована дія
1001	Недійсний формат запиту	Переконайтеся, що тіло вашого запиту є дійсним JSON.
1002	Відсутнє обов’язкове поле	Перевірте властивість message у відповіді, щоб побачити, яке поле відсутнє.
1003	Недійсний номер телефону	Переконайтеся, що номер одержувача має формат E.164 (наприклад, 380501234567).
1004	Незареєстрована альфа-ім’я	Параметр «від» містить альфа-ім’я, яке не було схвалено для вашого облікового запису.
1005	Недостатній баланс	На вашому рахунку недостатньо коштів для обробки кампанії обміну повідомленнями.
1006	Недійсний тип повідомлення	Параметр type має бути одним із підтримуваних типів (наприклад, sms, viber_promo).
1007	Шаблон не знайдено	Запитаний ідентифікатор шаблону Viber/OTP недійсний або не затверджений.
1008	Недійсні елементи каруселі	Карусель Viber має містити від 2 до 5 елементів.

[!ПОРАДА] Якщо ви зіткнулися з кодом помилки, якого тут немає, або якщо ви вважаєте, що помилка була повернена помилково, зв’яжіться з [email protected] і надайте точне корисне навантаження та заголовки відповіді.