FAQAPI

Отримати статус оренди номера

Метод getRentStatus використовується для отримання актуального статусу орендованого віртуального номера через API SMS.online. Він дозволяє автоматизувати процес перевірки стану оренди та відстежувати надходження SMS-кодів на орендований номер.

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

Успішний запит повертає об'єкт з інформацією про актуальний статус оренди, включаючи унікальний ідентифікатор оренди, список отриманих SMS-кодів та час закінчення оренди. Це дозволяє ефективно контролювати використання номера та отримання повідомлень в реальному часі.

Приклад запиту:

Вхідні дані

ПараметрОбов'язковийПриміткаОпис
ТакДив. у профілі в налаштуваннях API КлючAPI-ключ забезпечує доступ до оплачуваних послуг
ТакgetRentStatusНазва методу
ТакЧислове значенняID активації, отримане при запиті номера
НіЧислове значенняНомер сторінки, з якої починається вибірка (нумерація сторінок ведеться з 0, від нових до старих; за замовчуванням 0)
НіЧислове значенняКількість запитуваних сторінок (за замовчуванням 10)

Відповідь сервера

JSON
{
  "status": "success", 
  "quantity": "2", 
  "values": { 
    "0": { 
      "phoneFrom": "79180230628", 
      "text": "5", 
      "service": "ot", 
      "date": "2020-01-30 14:31:58" 
    }, 
    "1": { 
      "phoneFrom": "79180230628", 
      "text": "4", 
      "service": "ot", 
      "date": "2025-05-30 14:04:16" 
    } 
  } 
}

Приклад коду

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

Можливі помилки

ПараметрОпис
Некоректна дія
Невірний API-ключ
Помилка в запиті
Час, на який аккаунт заблоковано
Аккаунт не активний
Не вказано ID оренди
Номер орендовано не вами (неправильний ID оренди)
Оренда оплачена і завершена
Оренда скасована з поверненням грошей
Очікування першої смс
Номер заблоковано, вам повернені кошти