Змінити статус оренди

Метод 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 хв.)
Оренда вже завершена
Оренда вже скасована