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

Метод sms-cancel-bulk предназначен для отмены массовой рассылки SMS. Можно отменить только ту рассылку, которая находится в одном из статусов: paused ready unpaid.

При отмене массовой рассылки SMS производится отмена и разблокировка средств по тем сообщениям, которые находятся в статусе ready, при этом рассылка далее переводится в статус paused. Это необходимо для корректной обработки тех SMS, которые на момент отмены не находились в статусе ready и предотвращения их несанкционированной рассылки. Если при отмене рассылки все сообщения были в статусе ready, то массовая рассылка удаляется полностью.

Параметры запроса

Параметр	Тип	Обязательный	Описание
id	string	Да	Идентификатор рассылки

Пример запроса

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "sms-cancel-bulk",
    "data": {
        "id": "8a482981-787e-494a-9b1a-63696cd208fe"
    }
}

Параметры ответа

Параметр	Тип	Описание
id	string	Идентификатор рассылки
created	datetime	Дата и время создания рассылки в формате ISO 8601
updated	datetime	Дата и время обновления рассылки в формате ISO 8601
signature	string	Подпись отправителя SMS
message	string	Текст сообщения SMS
num	integer	Количество SMS
total	double	Полная стоимость рассылки
status	string	Статус рассылки
paid	boolean	Состояние списания средств за рассылку

Пример ответа

{
    "success": true,
    "data": {
        "id": "8a482981-787e-494a-9b1a-63696cd208fe",
        "created": "2024-01-31T09:18:46+03:00",
        "updated": "2024-01-31T09:18:46+03:00",
        "signature": "TestSMS",
        "message": "Test phonebook params: {first_name} {middle_name}",
        "num": 2,
        "total": 4.98,
        "status": "cancel",
        "paid": true
    }
}

Возможные ошибки

Ошибка	Описание
SMS-CANCEL-BULK-ID-REQUIRED	Не указан параметр id
SMS-CANCEL-BULK-ID-INVALID-TYPE	Параметр id имеет недопустимый тип
SMS-CANCEL-BULK-ID-INVALID-FORMAT	Параметр id не соответствует формату
SMS-CANCEL-BULK-ID-NOT-FOUND	Массовая рассылка SMS не найдена
SMS-CANCEL-BULK-REJECTED	Массовая рассылка SMS не находится в одном из статусов: paused ready unpaid