Перейти к содержимому

Расчет стоимости одиночной SMS ​

sms-calculate · POST /api/json/2020-01-01 · Все действия

Расчет не создает SMS и не резервирует деньги. Проверяет подпись, черный список, номерной план и маршрут. Цена — за одну часть, total — за все части. Последующее создание повторно проверяет условия.

Запрос ​

ПолеТипОбязательноПравило
signature_idstringДаID собственной одобренной SMS-подписи.
phonestringДаЗнак + и 9–15 цифр без разделителей.
messagestringДа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Идентификатор подписи отправителя не указан