Отмена отправки сообщения SMS

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

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

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

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

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "sms-pause",
    "data": {
        "id": "0cd2d91a-559a-4e11-8bb7-ebdbaa4f324a"
    }
}

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

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

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

{
    "success": true,
    "data": {
        "id": "0cd2d91a-559a-4e11-8bb7-ebdbaa4f324a",
        "created": "2024-01-31T08:10:32+03:00",
        "updated": "2024-01-31T08:11:12+03:00",
        "signature": "TestSMS",
        "phone": "+79401234567",
        "message": "SMS test message",
        "parts": 1,
        "price": 2.49,
        "total": 2.49,
        "status": "cancel",
        "paused": false,
        "paid": true
    }
}

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

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