Оформление
Приостановка массовой рассылки
sms-pause-bulk · POST /api/json/2020-01-01 · Все действия
Принимается для рассылки в ready, если удалось приостановить хотя бы одну готовую SMS без текущей обработки. Изменения рассылки и ее SMS выполняются вместе. Уже переданные шлюзу части продолжают обрабатываться.
Запрос
| Поле | Тип | Обязательно | Правило |
|---|---|---|---|
id | string | Да | 24 строчных шестнадцатеричных символа; документ должен быть доступен владельцу ключа. |
Иллюстративный запрос (ключ и ID замените собственными):
json
{
"api_key": "00000000-0000-0000-0000-000000000001",
"action": "sms-pause-bulk",
"data": {
"id": "000000000000000000000001"
}
}Результат
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": "paused",
"paid": true
}
}Отказы
Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.
| Код | Причина |
|---|---|
SMS-PAUSE-BULK-ID-INVALID-FORMAT | Идентификатор массовой рассылки SMS имеет недопустимый формат |
SMS-PAUSE-BULK-ID-INVALID-TYPE | Идентификатор массовой рассылки SMS имеет недопустимый тип значения |
SMS-PAUSE-BULK-ID-NOT-FOUND | Массовая рассылка SMS с таким идентификатором не найдена |
SMS-PAUSE-BULK-ID-REQUIRED | Идентификатор массовой рассылки SMS не указан |
SMS-PAUSE-BULK-REJECTED | Запрос отклонен |