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

GET /api/rent/getRentNum.php

Купить виртуальный номер телефона для аренды

Данный запрос позволяет Вам арендовать номер конкретной страны для приема SMS-сообщений.

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

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

apikey

BearerAuth

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

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

Параметры

query5

Название	Тип	Описание
`country`	`integer` ≥ 1	'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов стран' По умолчанию:`7`Пример:`46`
`days`*	`integer` ≥ 1	'Начальный срок аренды (в днях), доступные срок указаны в ответе tariffsRent' Пример:`1`
`extension`	`boolean`	'Автопродление (когда включено, по истечению срока аренды автоматически продляет её на 30 дней, если на балансе достаточно средств)' По умолчанию:`true`
`pagination`	`boolean`	Пагинация сообщений
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке. Перечисление:`frderuenzh`По умолчанию:`ru`Пример:`en`

Ответы

200

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

Content-Typeapplication/json

Схема

Responseobject

responseoneOf

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

Пример:1

Одно из

[0]integer

[1]string

itemobject

statusinteger

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

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

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

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

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

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

Пример:0

messagesobject

current_pageinteger

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

≥ 1

Пример:1

dataobject[]

itemsobject

frominteger

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

≥ 1

Пример:1

last_pageinteger

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

≥ 0

Пример:12

per_pageinteger

Количество сообщений, отображаемых на одной странице

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

tointeger

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

≥ 0

Пример:2

totalinteger

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

≥ 0

Пример:4

countryinteger

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

≥ 1

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

rentinteger

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

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

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

2 - DEPRECATED номер недоступен

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

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

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

extensioninteger

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

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

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

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

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

checked_timestring

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

Формат:date-timeПример:2022-07-17 11:55:13

sumnumber

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

≥ 0

Пример:215.5

numberstring

Номер телефона, без кода страны

Пример:9108501010

tzidinteger

ID операции

≥ 1

Пример:10000

timeinteger

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

≥ 0

Пример:19

daysinteger

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

≥ 0

Пример:0

hoursinteger

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

≥ 0

Пример:14

extendobject

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

"extension_period_in days"integer

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

checkedboolean

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

reloadinteger

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

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

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

Пример:1

day_extendinteger

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

≥ 1

Пример:36

m_extboolean

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

freezeboolean

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

Примеры

Successfully issued rental number37 строк

{
  "response": 1,
  "item": {
    "status": 0,
    "messages": {
      "current_page": 1,
      "data": [],
      "from": 1,
      "last_page": 0,
      "per_page": 20,
      "to": 0,
      "total": 0
    },
    "country": 7,
    "rent": 3,
    "extension": 1,
    "checked_time": "2022-07-17 21:41:20",
    "sum": 215.5,
    "number": "9915584307",
    "tzid": 22867974,
    "time": 19,
    "days": 0,
    "hours": 0,
    "extend": {
      "1": 36,
      "3": 108,
      "7": 252,
      "15": 540,
      "30": 1080
    },
    "checked": false,
    "reload": 0,
    "day_extend": 36,
    "m_ext": false,
    "freeze": false
  }
}

Примеры кода

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