Изменить статус аренды

Метод setRentStatus используется для изменения текущего статуса арендованного виртуального номера через API SMS.online. Этот метод позволяет автоматизировать управление статусами аренды, включая завершение использования номера, продление срока аренды или его освобождение.

Метод предназначен для систем, которые требуют оперативного контроля статуса арендованных номеров в реальном времени. С его помощью можно указывать завершение аренды, продление или другие изменения статуса, поддерживая актуальность информации.

Успешный запрос возвращает объект с подтверждением изменения статуса аренды, включая обновлённые параметры аренды. Метод особенно полезен в сервисах, где требуется быстрое обновление информации по использованию арендованных номеров.

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

Входные данные

ПараметрОбязательныйПримечаниеОписание
ДаСм. в профиле в настройках API КлючAPI-ключ обеспечивает доступ к оплаченным услугам
ДаsetRentStatusНазвание метода
ДаЧисловое значениеID активации, полученное при запросе номера
ДаЧисловое значениеСтатус аренды

Статус может принимать значения:

1 - Завершить работу с номером

2 - Отменить покупку

Ответ сервера

JSON
{ 
  "status": "success"
}

Пример кода

const api_key = "API_KEY"; # Замените 'API_KEY' на ваш реальный API-ключ.
const id = 1; # Вставьте ID активации, полученное при запросе номера
const status = 1; # Вставьте новый статус из таблицы выше
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=setRentStatus&id=${id}&status=${status}`);
# Выполняем GET-запрос к указанному URL
const data = await response.json();
# Выводим содержимое ответа от сервера
console.log(data);
} catch (err) {
# Если произошла ошибка, выводим сообщение об ошибке
console.error(err);
}

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

ПараметрОписание
Некорректное действие
Неверный API-ключ
Ошибка в запросе
Время на которое аккаунт заблокирован
Аккаунт не активен
Не указан ID аренды
Номер арендован не вами (неправильный ID аренды)
Отсутствует или неправильно указан статус
Невозможно отменить аренду (более 20 мин.)
Аренда уже завершена
Аренда уже отменена