Общее описание
1. Общее описание
Данный REST API предназначен для взаимодействия клиентов с сервисом уведомлений.
Все запросы к API осуществляются по протоколу HTTP. Тело запроса передается в формате JSON. При этом необходимо устанавливать Content-type: application/json. Также в параметре charset необходимо передавать значение кодировки - UTF-8. Формат для отправки даты и времени ISO 8601. Время передается в часовом поясе UTC.
1.1. Аутентификация
Используется Basic аутентификация.
1.2. Общий формат ответа
Используются HTTP ответы с соответствующими кодами. Если какая-либо переменная ответа имеет несколько значений, они формируются в виде массива. Если в запросе было несколько значений какой-либо переменной, в ответе значения будут в том же порядке.
Если запрос содержит ошибку (код 400), то в теле ответа обязательно присутствует JSON-объект со следующими полями.
Таблица 1.1 – Параметры ответа при ошибочном выполнении
Имя | Тип | Обязательность | Описание | |
|---|---|---|---|---|
| 1 | error_code | string | да | Код ошибки |
| 2 | error_description | string | да | Описание ошибки |
1.3. Коды ошибок
Данные коды возвращаются при получении HTTP ответа с кодом 400. И являются значениями поля "error_code", описанного выше.
Краткое описание ошибок:
1XX - общие ошибки, ошибки "верхнего" уровня
2XX - ошибки блока messages
3XX - ошибки блока timing
4XX - ошибки блоков каналов и блока content
Таблица 1.2 – Коды ошибок
Код | Описание | Перевод | |
|---|---|---|---|
| 1 | 101 | Syntax error | Синтаксическая ошибка |
| 2 | 102 | Account lock | Аккаунт клиента заблокирован |
| 3 | 103 | Empty channel | Не задан канал для отправки сообщений |
| 4 | 104 | Invalid priority | Указано некорректное значение параметра priority |
| 5 | 105 | Too much IDs | Передано слишком много идентификаторов сообщений |
| 6 | 106 | Invalid template | Некорректный шаблон |
| 7 | 202 | Empty recipient | Адрес получателя не задан (кроме канала email) |
| 8 | 203 | Invalid recipient | Адрес получателя задан некорректно (кроме канала email) |
| 9 | 204 | Empty email address | Адрес электронной почты получателя не задан (для канала email) |
| 10 | 205 | Empty message-id | Идентификатор сообщения не задан |
| 11 | 206 | Invalid variables | Указано некорректное значение параметра variables |
| 12 | 207 | Invalid message-id | Указано некорректное значение параметра message-id |
| 13 | 301 | Invalid localtime | Указано некорректное значение параметра localtime |
| 14 | 302 | Invalid start-datetime | Указано некорректное значение параметра start-datetime |
| 15 | 303 | Invalid end-datetime | Указано некорректное значение параметра end-datetime |
| 16 | 304 | Invalid allowed-starttime | Указано некорректное значение параметра allowed-starttime |
| 17 | 305 | Invalid allowed-endtime | Указано некорректное значение параметра allowed-endtime |
| 18 | 306 | Invalid send-evenly | Указано некорректное значение параметра send-evenly |
| 19 | 307 | Invalid allowed-days | Указано некорректное значение параметра allowed-days |
| 20 | 401 | Empty originator | Адрес отправителя не указан |
| 21 | 402 | Empty application | Приложение не указано |
| 22 | 403 | Empty ttl | Значение ttl не указано (если задано несколько каналов отправки) |
| 23 | 404 | Empty content | Содержимое сообщения не указано |
| 24 | 405 | Content error | Неправильный формат содержимого контента |
| 25 | 406 | Invalid content | Недопустимое значение контента для указанного канала |
| 26 | 407 | Invalid ttl | Неправильно указано значение времени ожидания доставки |
| 27 | 408 | Invalid attached files | Прикрепленные файлы имеют объем более 1МБ. Применимо, если файл передается в теле запроса в base64. |
| 28 | 410 | Invalid retry-attempts | Неправильно указано значение количества попыток дозвона |
| 29 | 411 | Invalid retry-timeout | Неправильно указано значение времени повторного дозвона |