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

Оформление

Создание массовой SMS-рассылки ​

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

Номера из чёрного списка и недоступные для отправки номера пропускаются. В справочнике также пропускаются получатели с незаполненными подстановками. Для ручного списка используйте текст без подстановок. Если получателей не осталось, возвращается SMS-CREATE-BULK-EMPTY. При from < till сообщения планируются в указанном интервале; время доставки может отличаться.

Запрос ​

ПолеТипОбязательноПравило
signature_idstringДаID собственной одобренной SMS-подписи.
phonebook_typestringДаphonebook или phonelist.
phonebook_idstringПри phonebookID собственного телефонного справочника.
phonelistarray<string>При phonelist1–500000 номеров; повторяющиеся нормализованные номера объединяются.
messagestringДа1–1000 символов после нормализации; для справочника возможны подстановки вида {{Имя}}.
filtersobjectНет, только phonebookФильтры ниже; с phonelist поле не принимается.
filters.birthdayobjectНетДиапазон дня и месяца; сравнение внутри одного календарного диапазона.
filters.birthday.minstringНетНижняя граница MM-DD, например 02-01.
filters.birthday.maxstringНетВерхняя граница MM-DD, например 02-29.
filters.genderstringНетmale или female.
scheduleobjectНетБез поля — немедленная отправка; при наличии обязателен from.
schedule.fromstringПри scheduleISO 8601; сейчас −1 час … сейчас +30 суток.
schedule.tillstringНетНе раньше from, не позже сейчас +30 суток. Без поля равен from.
expirestringНетtill +1 час … till +3 суток; по умолчанию till +3 суток.
request_idstringНетКлюч повтора: 1–64 латинских буквы, цифры, дефисы или подчеркивания; см. общие правила.

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

json
{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-create-bulk",
  "data": {
    "signature_id": "000000000000000000000002",
    "phonebook_type": "phonelist",
    "phonelist": [
      "+79401234567",
      "+79409876543"
    ],
    "message": "Проверка связи",
    "request_id": "campaign-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",
    "message": "Проверка связи",
    "num": 2,
    "total": 4.98,
    "status": "reserve",
    "paid": false
  }
}

Отказы ​

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

КодПричина
SMS-CREATE-BULK-EMPTYМассовая рассылка SMS не содержит тарифицируемых сообщений
SMS-CREATE-BULK-EXPIRE-INVALID-FORMATСрок действия имеет недопустимый формат
SMS-CREATE-BULK-EXPIRE-INVALID-RANGEЯвный срок жизни должен быть от 1 часа до 3 суток после планового времени (для рассылки — после till).
SMS-CREATE-BULK-EXPIRE-INVALID-TYPEСрок действия имеет недопустимый тип значения
SMS-CREATE-BULK-FILTERS-BIRTHDAY-INVALID-TYPEДень рождения имеет недопустимый тип значения
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-FORMATМаксимальный день рождения имеет недопустимый формат
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-TYPEМаксимальный день рождения имеет недопустимый тип значения
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-FORMATМинимальный день рождения имеет недопустимый формат
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-TYPEМинимальный день рождения имеет недопустимый тип значения
SMS-CREATE-BULK-FILTERS-GENDER-INVALID-TYPEПол имеет недопустимый тип значения
SMS-CREATE-BULK-FILTERS-GENDER-NOT-SUPPORTEDПол имеет недопустимое значение
SMS-CREATE-BULK-FILTERS-INVALID-TYPEНастройки фильтров имеют недопустимый тип значения
SMS-CREATE-BULK-MESSAGE-INVALID-FORMATСообщение имеет недопустимый формат
SMS-CREATE-BULK-MESSAGE-INVALID-TYPEСообщение имеет недопустимый тип значения
SMS-CREATE-BULK-MESSAGE-REQUIREDСообщение не указано
SMS-CREATE-BULK-PHONEBOOK-ID-INVALID-FORMATИдентификатор списка получателей имеет недопустимый формат
SMS-CREATE-BULK-PHONEBOOK-ID-INVALID-TYPEИдентификатор списка получателей имеет недопустимый тип значения
SMS-CREATE-BULK-PHONEBOOK-ID-NOT-FOUNDСписок получателей с таким идентификатором не найден
SMS-CREATE-BULK-PHONEBOOK-ID-REQUIREDИдентификатор списка получателей не указан
SMS-CREATE-BULK-PHONEBOOK-TYPE-INVALID-TYPEТип списка получателей имеет недопустимый тип значения
SMS-CREATE-BULK-PHONEBOOK-TYPE-NOT-SUPPORTEDТип списка получателей имеет недопустимое значение
SMS-CREATE-BULK-PHONEBOOK-TYPE-REQUIREDТип списка получателей не указан
SMS-CREATE-BULK-PHONELIST-INVALID-FORMATСписок получателей имеет недопустимый формат
SMS-CREATE-BULK-PHONELIST-INVALID-RANGEСлишком много номеров в списке
SMS-CREATE-BULK-PHONELIST-INVALID-TYPEСписок получателей имеет недопустимый тип значения
SMS-CREATE-BULK-PHONELIST-REQUIREDСписок получателей не указан
SMS-CREATE-BULK-REQUEST-ID-INVALID-FORMATКлюч идемпотентности имеет недопустимый формат
SMS-CREATE-BULK-REQUEST-ID-INVALID-TYPEКлюч идемпотентности имеет недопустимый тип значения
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-FORMATВремя начала рассылки имеет недопустимый формат
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-RANGEfrom должен быть в диапазоне сейчас −1 час … сейчас +30 суток.
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-TYPEВремя начала рассылки имеет недопустимый тип значения
SMS-CREATE-BULK-SCHEDULE-FROM-REQUIREDВремя начала рассылки не указано
SMS-CREATE-BULK-SCHEDULE-INVALID-TYPEРасписание рассылки имеет недопустимый тип значения
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-FORMATВремя окончания рассылки имеет недопустимый формат
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-RANGEtill не раньше from и не позже сейчас +30 суток.
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-TYPEВремя окончания рассылки имеет недопустимый тип значения
SMS-CREATE-BULK-SIGNATURE-ID-INVALID-FORMATИдентификатор подписи отправителя имеет недопустимый формат
SMS-CREATE-BULK-SIGNATURE-ID-INVALID-TYPEИдентификатор подписи отправителя имеет недопустимый тип значения
SMS-CREATE-BULK-SIGNATURE-ID-NOT-APPROVEDПодпись отправителя с таким идентификатором не подтверждена
SMS-CREATE-BULK-SIGNATURE-ID-NOT-FOUNDПодпись отправителя с таким идентификатором не найдена
SMS-CREATE-BULK-SIGNATURE-ID-REQUIREDИдентификатор подписи отправителя не указан