Оформление
Расчет стоимости одиночной SMS
sms-calculate · POST /api/json/2020-01-01 · Все действия
Расчет не создает SMS и не резервирует деньги. Проверяет подпись, черный список, номерной план и маршрут. Цена — за одну часть, total — за все части. Последующее создание повторно проверяет условия.
Запрос
| Поле | Тип | Обязательно | Правило |
|---|---|---|---|
signature_id | string | Да | ID собственной одобренной SMS-подписи. |
phone | string | Да | Знак + и 9–15 цифр без разделителей. |
message | string | Да | 1–1000 символов после нормализации; стоимость зависит от кодировки и числа частей. |
Иллюстративный запрос (ключ и ID замените собственными):
json
{
"api_key": "00000000-0000-0000-0000-000000000001",
"action": "sms-calculate",
"data": {
"signature_id": "000000000000000000000002",
"phone": "+79401234567",
"message": "Проверка связи"
}
}Результат
data — объект; поля описаны в общем контракте результатов.
json
{
"success": true,
"data": {
"parts": 1,
"price": 2.49,
"total": 2.49
}
}Отказы
Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.
| Код | Причина |
|---|---|
SMS-CALCULATE-MESSAGE-INVALID-FORMAT | Сообщение имеет недопустимый формат |
SMS-CALCULATE-MESSAGE-INVALID-TYPE | Сообщение имеет недопустимый тип значения |
SMS-CALCULATE-MESSAGE-REQUIRED | Сообщение не указано |
SMS-CALCULATE-PHONE-BLACKLISTED | Номер телефона включен в черный список |
SMS-CALCULATE-PHONE-INVALID-FORMAT | Номер телефона имеет недопустимый формат |
SMS-CALCULATE-PHONE-INVALID-TYPE | Номер телефона имеет недопустимый тип значения |
SMS-CALCULATE-PHONE-OPERATOR-NOT-FOUND | Оператор номера телефона не определен |
SMS-CALCULATE-PHONE-REQUIRED | Номер телефона не указан |
SMS-CALCULATE-PHONE-ROUTE-NOT-FOUND | Маршрут для номера телефона не определен |
SMS-CALCULATE-SIGNATURE-ID-INVALID-FORMAT | Идентификатор подписи отправителя имеет недопустимый формат |
SMS-CALCULATE-SIGNATURE-ID-INVALID-TYPE | Идентификатор подписи отправителя имеет недопустимый тип значения |
SMS-CALCULATE-SIGNATURE-ID-NOT-APPROVED | Подпись отправителя с таким идентификатором не подтверждена |
SMS-CALCULATE-SIGNATURE-ID-NOT-FOUND | Подпись отправителя с таким идентификатором не найдена |
SMS-CALCULATE-SIGNATURE-ID-REQUIRED | Идентификатор подписи отправителя не указан |