Адаптер для индивидуальной и массовой рассылки СМС.
Взаимодействие с СМС адаптером осуществляется по протоколу HTTP методом POST. Данные передаются в теле запроса в формате JSON.
В теле каждого запроса и ответа находится одинаковая базовая модель, значения параметров которой изменяются в зависимости от выбранного метода.
Наименование | Тип данных | Описание |
---|---|---|
action | String | Наименование метода |
token | String | Токен |
data | Object | Объект данных |
{
"action": "action",
"token": "token",
"data": {...}
}
Модель тела ответа, в случае успешного выполнения метода:
Наименование | Тип данных | Описание |
---|---|---|
ok | Boolean | Статус успешности выполнения метода: true - Успешно |
result | Object | Выходная модель метода |
Пример тела ответа, в случае успешного выполнения метода:
{
"ok": true,
"result": {...}
}
Модель тела ответа, в случае логической ошибки при выполнении метода:
Наименование | Тип данных | Описание |
---|---|---|
ok | Boolean | Статус успешности выполнения метода: false - Логическая ошибка |
result | Error | Модель логической ошибки |
Error
Модель, описывающая логическую ошибку при выполнении метода:
Наименование | Тип данных | Описание |
---|---|---|
error | Int32 | Код ошибки |
description | String | Описание ошибки |
Пример тела ответа, в случае логической ошибки при выполнении метода:
{
"ok": true,
"result": {
"error": 1234,
"description": "Something went wrong!",
}
}