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

GET /api/rent/extendRentState.php

Продлить срок аренды виртуального номера

Продляет аренду на указанный период (в днях).

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

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

apikey

BearerAuth

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

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

Параметры

query3

Название	Тип	Описание
`tzid`*	`integer` ≥ 1	ID операции Пример:`10000`
`days`*	`integer` ≥ 0	'Период продления аренды (в днях). Может принимать только значения, указанные в разделе `extend` ответа getRentState' Пример:`15`
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке. Перечисление:`frderuenzh`По умолчанию:`ru`Пример:`en`

Ответы

200

'Успешный ответ на запрос extendRentState: продляет аренду номера с заданными параметрами или выбрасывает исключение.'

Content-Typeapplication/json

Схема

Responseobject

responseoneOf

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

Пример:1

Одно из

[0]integer

[1]string

itemobject

Список активных арендных номеров Вашего профиля

statusinteger

Пример:1

extensioninteger

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

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

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

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

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

messagesobject

current_pageinteger

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

Пример:1

dataoneOf[]

itemsoneOf

Одно из

[0]object

[1]object[]

frominteger

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

≥ 1

Пример:1

last_pageinteger

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

≥ 1

Пример:12

per_pageinteger

Количество сообщений, отображаемых на одной странице (20 по умолчанию)

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

tointeger

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

≥ 1

Пример:12

totalinteger

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

≥ 1

Пример:234

sumnumber

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

≥ 1

Пример:251.5

countryinteger

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

Пример:46

checked_timestring

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

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

numberstring

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

Пример:9915584307

rentinteger

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

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

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 rental extention response47 строк

{
  "response": 1,
  "item": {
    "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
  }
}

Примеры кода

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