FAQAPI

Получение истории аренды

Метод getRentHistory используется для получения полного списка всех арендованных виртуальных номеров, связанных с учётной записью через API SMS.online. Он позволяет автоматизировать анализ использования номеров в долгосрочной аренде и отслеживать затраты на продление.

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

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

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

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

ПараметрОбязательныйПримечаниеОписание
ДаСм. в профиле в настройках API КлючAPI-ключ обеспечивает доступ к оплаченным услугам
ДаgetRentHistoryНазвание метода
НетВременная метка в формате Unix TimestampС какой даты брать активации (ограничено 30 днями)
НетВременная метка в формате Unix TimestampПо какую дату брать активации (ограничено 30 днями)
НетЧисловое значениеСмещение первого элемента, возвращаемого в ответе (по-умолчанию 0)
НетЧисловое значениеКоличество элементов, возвращаемых в ответе (по-умолчанию 50, максимум 100)

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

JSON
[
  {
    "id": 635468024,
    "date": "2022-11-12 15:58:39",
    "phone": "79918529716",
    "sms": "["Your sms code"]",
    "cost": 100
    "status": "4"
  }
]

Пример кода

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

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

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