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 аренды)
Аренда оплачена и завершена
Аренда отменена с возвратом денег
Ожидание первой смс
Номер заблокирован, вам возвращены средства