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

Параметры

query3

Название	Тип	Описание
`tzid`	`integer`	'ID операции. Если не указано, запрос вернет полный список арендных номеров Вашего профиля.'
`pagination`	`boolean`	Режим пагинации для обзора списка сообщений (если `false` - выключен) По умолчанию:`false`Пример:`false`
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке. Перечисление:`frderuenzh`По умолчанию:`ru`Пример:`en`

Ответы

200

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

Content-Typeapplication/json

Схема

Responseobject

responseoneOf

1, если запрос был выполнен успешно, либо выведет сообщение об ошибке

Пример:1

Одно из

[0]integer

[1]string

listobject[]

Список текущих арендных операций

itemsobject

statusinteger

'Код статуса аренды, сразу после выдачи всегда 0:

0 - ожидание подтверждения операции (SMS должна быть получена в течение 20 минут после заказа, в противном случае операция будет отменена, а средства возвращены на баланс аккаунта)

1 - аренда активна

2 - DEPRECATED номер отключен

3 - DEPRECATED ошибка аренды

4 - номер был заморожен'

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

extensioninteger

'Доступность продления аренды этого номера:

0 - продление недоступно

1 - продление доступно

2 - автопродление (аренда автоматически продлится на 30 дней по истечении текущего срока, если на балансе достаточно средств)'

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

messagesobject[]

itemsobject

idinteger

ID сообщения

≥ 1

Пример:1

servicestring

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

Пример:Google

textstring

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

Пример:Your verification code is 070051

codestring

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

Пример:070051

created_atstring

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

Пример:2022-07-17 21:46:58

sumstring

Общая стоимость аренды (начальный период + периоды продления)

Пример:251.5

countryinteger

'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов стран'

Пример:46

checked_timestring

Дата и время взятия номера в аренду

Пример:2022-07-17 21:41:20

numberstring

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

Пример:9915584307

rentinteger

'Код статуса аренды, сразу после выдачи всегда 0:

1 - аренда активна

2 - DEPRECATED номер отключен

3 - DEPRECATED ошибка аренды

4 - номер был заморожен'

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

tzidinteger

ID операции

≥ 1

Пример:10000

timeinteger

Оставшееся время аренды, (в минутах)

≥ 1

Пример:5750

daysinteger

Оставшееся время аренды, (в днях)

≥ 0

Пример:3

hoursinteger

Оставшееся время аренды, (в часах)

≥ 1

Пример:95

extendobject

Стоимость продления

#period_in_days#integer

Стоимость каждого доступного периода продления

≥ 1

Пример:36

checkedboolean

'Статус активации номера (для активации номер должен принять SMS в течение 20 минут после начала операции, в противном случае будет автоматически выполнен возврат средств, а операция закрыта)'

reloadinteger

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

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

1 - перезагрузка доступна'

Пример:1

day_extendinteger

Стоимость продления аренды на 1 день

≥ 1

Пример:36

m_extboolean

Аналоговый алгоритм для продления

freezeboolean

'Статус "заморозки" номера: если true - номер заморожен, и для продолжения аренды необходимо его разморозить'

Примеры

Successful response to get all active rental operations39 строк

{
  "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.50",
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5728,
      "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
    }
  ]
}

Примеры кода

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