Отмена массовой рассылки

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

Принимает запрос отмены собственной рассылки выбранного проекта в состоянии ready, paused или unpaid, если она доступна для изменения. Успешный ответ подтверждает приём запроса. Итог отмены и оставшуюся стоимость проверяйте запросом статуса; уже отправленные сообщения отменить нельзя.

Запрос

Поле	Тип	Обязательно	Правило
id	string	Да	24 строчных шестнадцатеричных символа; документ должен быть доступен владельцу ключа.

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

{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-cancel-bulk",
  "data": {
    "id": "000000000000000000000001"
  }
}

Результат

data — объект; поля описаны в общем контракте результатов. Ответ действия содержит status=cancel. При последующем чтении результат может уже продвинуться дальше; обязательного наблюдения промежуточного cancel нет. После полной отмены чтение ID возвращает ошибку отсутствия документа.

{
  "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": "cancel",
    "paid": true
  }
}

Отказы

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

Код	Причина
SMS-CANCEL-BULK-ID-INVALID-FORMAT	Идентификатор имеет недопустимый формат
SMS-CANCEL-BULK-ID-INVALID-TYPE	Идентификатор массовой рассылки имеет недопустимый тип значения
SMS-CANCEL-BULK-ID-NOT-FOUND	Массовая рассылка с таким идентификатором не найдена
SMS-CANCEL-BULK-ID-REQUIRED	Идентификатор массовой рассылки не указан
SMS-CANCEL-BULK-REJECTED	Неподходящее состояние или рассылка уже занята обработкой; запрос не принят и новых пауз детям не оставляет