Документация YeSMS

Оформление

Создание одиночной SMS ​

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

Создает сообщение для дальнейшей обработки. Первый ответ обычно содержит status=reserve и paid=false: резервирование, передача шлюзу и доставка выполняются позже. Для отложенной SMS передавайте явный expire, рассчитанный от schedule.

Запрос ​

ПолеТипОбязательноПравило
signature_idstringДаID собственной одобренной SMS-подписи.
phonestringДаЗнак + и 9–15 цифр без разделителей.
messagestringДа1–1000 символов после нормализации; стоимость зависит от кодировки и числа частей.
schedulestringНетСтрогий ISO 8601 с секундами и смещением; сейчас −5 минут … сейчас +30 суток. Без поля — сейчас.
expirestringНетЯвное значение: schedule +1 час … schedule +3 суток. Без поля — сейчас +3 суток, даже при будущем schedule.
request_idstringНетКлюч повтора: 1–64 латинских буквы, цифры, дефисы или подчеркивания; см. общие правила.

Иллюстративный запрос (ключ и ID замените собственными):

json
{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-create",
  "data": {
    "signature_id": "000000000000000000000002",
    "phone": "+79401234567",
    "message": "Проверка связи",
    "request_id": "order-1001"
  }
}

Результат ​

data — объект; поля описаны в общем контракте результатов.

json
{
  "success": true,
  "data": {
    "id": "000000000000000000000001",
    "created": "2026-10-11T12:00:00+00:00",
    "updated": "2026-10-11T12:00:00+00:00",
    "signature": "TestSMS",
    "phone": "+79401234567",
    "message": "Проверка связи",
    "parts": 1,
    "price": 2.49,
    "total": 2.49,
    "status": "reserve",
    "paused": false,
    "paid": false
  }
}

Отказы ​

Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.

КодПричина
SMS-CREATE-EXPIRE-INVALID-FORMATСрок действия имеет недопустимый формат
SMS-CREATE-EXPIRE-INVALID-RANGEЯвный срок жизни должен быть от 1 часа до 3 суток после планового времени (для рассылки — после till).
SMS-CREATE-EXPIRE-INVALID-TYPEСрок действия имеет недопустимый тип значения
SMS-CREATE-MESSAGE-INVALID-FORMATСообщение имеет недопустимый формат
SMS-CREATE-MESSAGE-INVALID-TYPEСообщение имеет недопустимый тип значения
SMS-CREATE-MESSAGE-REQUIREDСообщение не указано
SMS-CREATE-PHONE-BLACKLISTEDНомер телефона включен в черный список
SMS-CREATE-PHONE-INVALID-FORMATНомер телефона имеет недопустимый формат
SMS-CREATE-PHONE-INVALID-TYPEНомер телефона имеет недопустимый тип значения
SMS-CREATE-PHONE-OPERATOR-NOT-FOUNDОператор номера телефона не определен
SMS-CREATE-PHONE-REQUIREDНомер телефона не указан
SMS-CREATE-PHONE-ROUTE-NOT-FOUNDМаршрут для номера телефона не определен
SMS-CREATE-REQUEST-ID-INVALID-FORMATКлюч идемпотентности имеет недопустимый формат
SMS-CREATE-REQUEST-ID-INVALID-TYPEКлюч идемпотентности имеет недопустимый тип значения
SMS-CREATE-SCHEDULE-INVALID-FORMATВремя отправки имеет недопустимый формат
SMS-CREATE-SCHEDULE-INVALID-RANGEschedule должен быть в диапазоне сейчас −5 минут … сейчас +30 суток.
SMS-CREATE-SCHEDULE-INVALID-TYPEВремя отправки имеет недопустимый тип значения
SMS-CREATE-SIGNATURE-ID-INVALID-FORMATИдентификатор подписи отправителя имеет недопустимый формат
SMS-CREATE-SIGNATURE-ID-INVALID-TYPEИдентификатор подписи отправителя имеет недопустимый тип значения
SMS-CREATE-SIGNATURE-ID-NOT-APPROVEDПодпись отправителя с таким идентификатором не подтверждена
SMS-CREATE-SIGNATURE-ID-NOT-FOUNDПодпись отправителя с таким идентификатором не найдена
SMS-CREATE-SIGNATURE-ID-REQUIREDИдентификатор подписи отправителя не указан