Расчет стоимости массовой рассылки

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

Возвращает число подходящих получателей (num) и общую стоимость (total). Номера из чёрного списка, недоступные для отправки и записи с незаполненными подстановками не учитываются. Если получателей нет, возвращаются num=0 и total=0. Расчёт не резервирует средства.

Запрос

Поле	Тип	Обязательно	Правило
signature_id	string	Да	ID собственной одобренной SMS-подписи.
phonebook_type	string	Да	phonebook или phonelist.
phonebook_id	string	При phonebook	ID собственного телефонного справочника.
phonelist	array<string>	При phonelist	1–500000 номеров; повторяющиеся нормализованные номера объединяются.
message	string	Да	1–1000 символов после нормализации; для справочника возможны подстановки вида {{Имя}}.
filters	object	Нет, только phonebook	Фильтры ниже; с phonelist поле не принимается.
filters.birthday	object	Нет	Диапазон дня и месяца; сравнение внутри одного календарного диапазона.
filters.birthday.min	string	Нет	Нижняя граница MM-DD, например 02-01.
filters.birthday.max	string	Нет	Верхняя граница MM-DD, например 02-29.
filters.gender	string	Нет	male или female.

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

{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-calculate-bulk",
  "data": {
    "signature_id": "000000000000000000000002",
    "phonebook_type": "phonelist",
    "phonelist": [
      "+79401234567",
      "+79409876543"
    ],
    "message": "Проверка связи"
  }
}

Результат

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

{
  "success": true,
  "data": {
    "num": 2,
    "total": 4.98
  }
}

Отказы

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

Код	Причина
SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-INVALID-TYPE	День рождения имеет недопустимый тип значения
SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-FORMAT	Максимальный день рождения имеет недопустимый формат
SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-TYPE	Максимальный день рождения имеет недопустимый тип значения
SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-FORMAT	Минимальный день рождения имеет недопустимый формат
SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-TYPE	Минимальный день рождения имеет недопустимый тип значения
SMS-CALCULATE-BULK-FILTERS-GENDER-INVALID-TYPE	Пол имеет недопустимый тип значения
SMS-CALCULATE-BULK-FILTERS-GENDER-NOT-SUPPORTED	Пол имеет недопустимое значение
SMS-CALCULATE-BULK-FILTERS-INVALID-TYPE	Настройки фильтров имеют недопустимый тип значения
SMS-CALCULATE-BULK-MESSAGE-INVALID-FORMAT	Сообщение имеет недопустимый формат
SMS-CALCULATE-BULK-MESSAGE-INVALID-TYPE	Сообщение имеет недопустимый тип значения
SMS-CALCULATE-BULK-MESSAGE-REQUIRED	Сообщение не указано
SMS-CALCULATE-BULK-PHONEBOOK-ID-INVALID-FORMAT	Идентификатор списка получателей имеет недопустимый формат
SMS-CALCULATE-BULK-PHONEBOOK-ID-INVALID-TYPE	Идентификатор списка получателей имеет недопустимый тип значения
SMS-CALCULATE-BULK-PHONEBOOK-ID-NOT-FOUND	Список получателей с таким идентификатором не найден
SMS-CALCULATE-BULK-PHONEBOOK-ID-REQUIRED	Идентификатор списка получателей не указан
SMS-CALCULATE-BULK-PHONEBOOK-TYPE-INVALID-TYPE	Тип списка получателей имеет недопустимый тип значения
SMS-CALCULATE-BULK-PHONEBOOK-TYPE-NOT-SUPPORTED	Тип списка получателей имеет недопустимое значение
SMS-CALCULATE-BULK-PHONEBOOK-TYPE-REQUIRED	Тип списка получателей не указан
SMS-CALCULATE-BULK-PHONELIST-INVALID-FORMAT	Список получателей имеет недопустимый формат
SMS-CALCULATE-BULK-PHONELIST-INVALID-RANGE	Слишком много номеров в списке
SMS-CALCULATE-BULK-PHONELIST-INVALID-TYPE	Список получателей имеет недопустимый тип значения
SMS-CALCULATE-BULK-PHONELIST-REQUIRED	Список получателей не указан
SMS-CALCULATE-BULK-SIGNATURE-ID-INVALID-FORMAT	Идентификатор подписи отправителя имеет недопустимый формат
SMS-CALCULATE-BULK-SIGNATURE-ID-INVALID-TYPE	Идентификатор подписи отправителя имеет недопустимый тип значения
SMS-CALCULATE-BULK-SIGNATURE-ID-NOT-APPROVED	Подпись отправителя с таким идентификатором не подтверждена
SMS-CALCULATE-BULK-SIGNATURE-ID-NOT-FOUND	Подпись отправителя с таким идентификатором не найдена
SMS-CALCULATE-BULK-SIGNATURE-ID-REQUIRED	Идентификатор подписи отправителя не указан