GET`https://onlinesim.io/api/rent/getRentState.php`

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

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

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

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

apikey

BearerAuth

OAuth2

rent-scope: grants access to renting phone numbers from Onlinesim

Параметры

query6

Название	Тип	Описание
`tzid`	`string`	ID операции, возвращается сервером при выдаче номера (в ответ на запрос getNum или getRentNum). Список активных операций профиля с их ID можно также через getState - для операций приема, и через getRentState - для операций аренды. Если ID операции не передан, ответ будет содержать данные обо всех операциях
`pagination`	`boolean`	Режим пагинации для обзора списка сообщений (если `false` - выключен) По умолчанию:`false`
`page`	`integer` ≥ 1	Страница сообщений (имеет смысл только при используемой пагинации)
`per_page`	`integer` ≥ 1	Количество сообщений на странице, по умолчанию — 20 (имеет смысл только при используемой пагинации) По умолчанию:`20`
`orderby`	`string`	Порядок сортировки сообщений по времени их поступления: `asc` - сортировка от старых к новым; `desc` - сортировка от новых к старым Перечисление:`ascdesc`По умолчанию:`desc`
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке Перечисление:`frderuenzh`По умолчанию:`ru`

Ответы

200

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

Content-Typeapplication/json

Схема

schemaoneOf

Успешный ответ или общая ошибка. OAuth-токен без rent-scope возвращает ошибку scope — см. компонент tariffsRentOAuthScopeError

Одно из

[0]object

[1]object

Примеры

Operation list with paginationexample_lines

Список с пагинацией SMS

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "extension": 1,
      "messages": {
        "current_page": 1,
        "data": [
          {
            "id": 1,
            "service": "Google",
            "text": "G-249833 – Ваш проверочный код.",
            "code": "249833",
            "created_at": "2022-07-17 21:46:58"
          }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 1,
        "total": 1
      },
      "sum": 251.5,
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5750,
      "days": 3,
      "hours": 95,
      "extend": {
        "1": 36,
        "3": 108,
        "7": 252,
        "15": 540,
        "30": 1080
      },
      "checked": true,
      "reload": 0,
      "day_extend": 36,
      "m_ext": false,
      "freeze": false
    }
  ]
}

Operation list with flat SMS arrayexample_lines

Плоский массив SMS (pagination=false)

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "extension": 1,
      "messages": [
        {
          "id": 1,
          "service": "Google",
          "text": "G-249833 – Ваш проверочный код.",
          "code": "249833",
          "created_at": "2022-07-17 21:46:58"
        }
      ],
      "sum": 251.5,
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5750,
      "days": 3,
      "hours": 95,
      "extend": {
        "1": 36,
        "3": 108,
        "7": 252,
        "15": 540,
        "30": 1080
      },
      "checked": true,
      "reload": 0,
      "day_extend": 36,
      "m_ext": false,
      "freeze": false
    }
  ]
}

Empty list

Нет активных операций аренды

{
  "response": 1,
  "list": []
}

Примеры кода

Генерация примеров...

GEThttps://onlinesim.io/api/rent/getRentState.php