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*string

Код страны (согласно списку стран)

days*integer

Начальный срок аренды (в днях). Допустимые значения — в объекте days ответа tariffsRent

extensionboolean

Автопродление (когда включено, по истечению срока аренды автоматически продляет её на 30 дней, если на балансе достаточно средств)

По умолчанию:true
paginationboolean

Пагинация сообщений

langstring

Язык ответа:

fr - французский,

de - немецкий,

ru - русский,

en - английский,

zh - китайский.

Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке

Перечисление:frderuenzhПо умолчанию:ru

Ответы

200

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

Content-Typeapplication/json
Схема
ResponseoneOf
Одно из
[0]object
responseintegerОбязательный

Номер в аренду успешно выдан

Перечисление:1
itemobjectОбязательный
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 — непредвиденная ошибка

Примеры

Virtual number successfully rented37 строк

Возвращает информацию об арендной операции

{
  "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
  }
}

Примеры кода

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