Проверка статуса массовой рассылки SMS

Метод sms-status-bulk предназначен для получения информации о состоянии массовой рассылки SMS.

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

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

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

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "sms-status-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": "done",
        "paid": true
    }
}

Возможные статусы

Статус	Описание
cancel	Отмененяется
done	Выполнена
init	Подготавливается к рассылке
paused	Приостановлена
ready	Готова к рассылке
reserve	Заблокирована стоимость на балансе пользователя
unpaid	Не может быть обработана, недостаточно средств

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

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