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

GET /api/rent/getRentState.php

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

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

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

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

apikey

BearerAuth

OAuth2Области: rent-scope

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

Схема

ResponseoneOf

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

Одно из

[0]object

responseintegerОбязательный

Код выполнения запроса: 1 - при успехе. Пустой list — не ошибка (нет активных аренд или неизвестный tzid)

Перечисление:1

listobject[]Обязательный

Список активных операций аренды (может быть пустым)

itemsobject

statusintegerОбязательный

Статус аренды:

0 — ожидание подтверждения (SMS должна прийти в течение 20 минут, иначе операция будет отменена)
1 — аренда активна
2 — DEPRECATED номер отключен
3 — DEPRECATED ошибка аренды
4 — номер заморожен

Перечисление:01234

messagesoneOfОбязательный

Список SMS. Возвращается объектом пагинации, когда pagination включена (по умолчанию), либо плоским массивом при pagination=false

Одно из

[0]object

current_pageintegerОбязательный

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

≥ 1

dataobject[]Обязательный

Список сообщений на текущей странице

itemsobject

idintegerОбязательный

ID сообщения

≥ 1

servicestringОбязательный

Номер или имя отправителя

textstringОбязательный

Текст SMS-сообщения

codestringОбязательный

Цифровой код из SMS-сообщения

created_atstringОбязательный

Дата и время получения SMS-сообщения

Шаблон:^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

fromintegerОбязательный

Номер первого сообщения на этой странице

≥ 0

last_pageintegerОбязательный

Номер последней страницы с полученными SMS

≥ 0

per_pageintegerОбязательный

Количество сообщений на одной странице

≥ 1

tointegerОбязательный

Номер последнего сообщения на этой странице

≥ 0

totalintegerОбязательный

Общее количество полученных этим номером сообщений

≥ 0

[1]object[]

itemsobject

idintegerОбязательный

ID сообщения

≥ 1

servicestringОбязательный

Номер или имя отправителя

textstringОбязательный

Текст SMS-сообщения

codestringОбязательный

Цифровой код из SMS-сообщения

created_atstringОбязательный

Дата и время получения SMS-сообщения

Шаблон:^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

countryintegerОбязательный

Код страны без + (например, 7, 46, 373)

rentintegerОбязательный

Срок аренды в днях (значение, переданное в days)

extensionintegerОбязательный

Доступность продления:

0 — продление недоступно
1 — продление доступно
2 — автопродление

Перечисление:012

checked_timestringОбязательный

Дата и время, когда номер был выдан

Шаблон:^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

sumnumberОбязательный

Стоимость аренды

≥ 0

numberstringОбязательный

Выданный виртуальный номер без кода страны

tzidintegerОбязательный

ID операции. Используйте его для получения информации о ней, продления или закрытия

≥ 1

timeintegerОбязательный

Оставшееся время до конца текущего окна, в минутах

≥ 0

daysintegerОбязательный

Оставшееся время до конца текущего окна, в днях

≥ 0

hoursintegerОбязательный

Оставшееся время до конца текущего окна, в часах

≥ 0

extendobjectОбязательный

Цены продления по срокам (дни → цена)

[additionalProperties]integer

≥ 0

checkedbooleanОбязательный

Подтверждена ли аренда SMS. false сразу после выдачи

reloadinteger | nullОбязательныйМожет быть null

Доступность перезагрузки номера:

0 — перезагрузка недоступна
1 — перезагрузка доступна

Перечисление:01

day_extendintegerОбязательный

Цена продления аренды на 1 день

≥ 1

m_extbooleanОбязательный

Служебный флаг алгоритма продления

freezebooleanОбязательный

Заморожен ли номер. Если true, аренда приостановлена до разморозки

[1]object

responsestringОбязательный

Код ошибки в формате UPPER_SNAKE_CASE, возвращается в поле response при HTTP-статусе 200. Список кодов не является закрытым и может пополняться. Неизвестный код следует трактовать как обобщенную ошибку и логировать для разбора.

Известные коды, сгруппированные по смыслу:

Параметры запроса

UNDEFINED_COUNTRY — некорректное значение параметра страны. Доступные значения — в списке стран;
UNDEFINED_DAYS — некорректный срок аренды или продления. Допустимые значения — в объекте days ответа tariffsRent - для базовых сроков аренды, и в объекте extend ответа getRentState - для продления;
ERROR_NO_SERVICE — некорректное значение параметра сервиса. Доступные значения — в списке сервисов.

Состояние и доступность

NO_NUMBER — нет доступных номеров с указанными параметрами. Повторите запрос позже или попробуйте другую страну;
WARNING_LOW_BALANCE — недостаточно средств на балансе.

Аккаунт и доступ

ACCOUNT_BLOCKED — аккаунт заблокирован;
API_ACCESS_DISABLED — доступ к API отключён в настройках профиля (см. тумблер API включено);
API_ACCESS_IP — IP-адрес отсутствует в allowlist (см. Доступ с IP).

Авторизация

ERROR_WRONG_KEY — некорректный API-ключ;
ERROR_NO_KEY — API-ключ отсутствует.

Лимиты запросов

INTERVAL_CONCURRENT_REQUESTS_ERROR — превышена допустимая частота или количество одновременных запросов.

Маршрутизация

REQUEST_NOT_FOUND — имя вызываемого метода некорректно или отсутствует.

Прочее

TRY_AGAIN_LATER — непредвиденная ошибка

Примеры

Operation list with pagination47 строк

Список с пагинацией 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 array39 строк

Плоский массив 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": []
}

Примеры кода

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