Skip to content

GET /api/rent/getRentState.php

Получить информацию о состоянии операции аренды

Этот запрос возвращает список активных арендных номеров.

Вы можете использовать его для быстрого просмотра всех активных арендных номеров (или только одного выбранного Вами) и полученных ими сообщений.

Безопасность

  • apikey
  • BearerAuth
  • OAuth2 (Области: rent-scope)
    • rent-scope: grants access to renting phone numbers from Onlinesim

Параметры

НазваниеТипОписание
tzidinteger

'ID операции.

Если не указано, запрос вернет полный список арендных номеров Вашего
профиля.’

paginationboolean

Режим пагинации для обзора списка сообщений (если false - выключен)

По умолчанию:falseПример:false
langstring

Язык ответа:

fr - французский,

de - немецкий,

ru - русский,

en - английский,

zh - китайский.
Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке.

Перечисление:frderuenzhПо умолчанию:ruПример:en

Ответы

200

‘Успешный ответ на запрос getRentState: сервер возвращает
информацию об указанной активной операции аренды (или обо всех
текущих операциях аренды) или выбрасывает исключение.’

Примеры кода