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

GET /api/rent/tariffsRent.php

Получить информацию о тарифах по аренде номеров

Получение информации о доступных для аренды номерах указанной страны (или всех странах, если не указана конкретная): тарифах и других параметрах аренды.

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

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

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

apikey

BearerAuth

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

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

Параметры

query2

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

Ответы

200

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

Content-Typeapplication/json

Схема

ResponseoneOf

Успешный ответ (все страны, одна страна или пустой массив) или ошибка (специфичная для метода или общая)

Одно из

[0]object

Карта стран. Ключи — коды стран в виде строк (например, "7", "46", "373"), значения — объекты rentCountryTariff

[additionalProperties]object

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

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

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

Флаг доступности аренды номеров этой страны (true - аренда доступна)

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

Slug страны (например, russia, moldova)

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

Служебный флаг для обозначения недавно добавленной страны

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

Позиция страны в списке по умолчанию

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

Остаток номеров по сроку аренды. Ключи — сроки в днях (1, 3, 7, 15, 30), значения — количество

[additionalProperties]integer

≥ 0

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

Цена по тем же срокам аренды. Ключи — сроки в днях, значения — цены

[additionalProperties]number

≥ 0

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

Количество номеров с возможностью продления

≥ 0

confirmboolean

true — средства списываются сразу, автовозврата при отсутствии SMS нет (в кабинете перед покупкой показывается дополнительное подтверждение)

[1]object

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

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

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

Флаг доступности аренды номеров этой страны (true - аренда доступна)

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

Slug страны (например, russia, moldova)

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

Служебный флаг для обозначения недавно добавленной страны

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

Позиция страны в списке по умолчанию

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

Остаток номеров по сроку аренды. Ключи — сроки в днях (1, 3, 7, 15, 30), значения — количество

[additionalProperties]integer

≥ 0

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

Цена по тем же срокам аренды. Ключи — сроки в днях, значения — цены

[additionalProperties]number

≥ 0

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

Количество номеров с возможностью продления

≥ 0

confirmboolean

[2]object[]

Пустой массив, возвращается при неизвестной стране

maxItems: 0

[3]object

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

Ошибка возвращается, когда OAuth-токен не содержит scope rent-scope: "Invalid scope(s) provided: rent-scope"

[4]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 — непредвиденная ошибка

Примеры

List of number rental tariffs for all countries25 строк

Перечень сроков и тарифов аренды и продления для всех стран

{
  "7": {
    "code": 7,
    "enabled": true,
    "name": "russia",
    "new": false,
    "position": 7,
    "count": {
      "1": 1153,
      "3": 1153,
      "7": 1153,
      "15": 1153,
      "30": 1153
    },
    "days": {
      "1": 121,
      "3": 215.5,
      "7": 400,
      "15": 700,
      "30": 1078.5
    },
    "extend": 1153,
    "confirm": false
  }
}

List of number rental tariffs for one country23 строк

Перечень сроков и тарифов аренды и продления для указанной страны

{
  "code": 7,
  "enabled": true,
  "name": "russia",
  "new": false,
  "position": 7,
  "count": {
    "1": 1153,
    "3": 1153,
    "7": 1153,
    "15": 1153,
    "30": 1153
  },
  "days": {
    "1": 121,
    "3": 215.5,
    "7": 400,
    "15": 700,
    "30": 1078.5
  },
  "extend": 1153,
  "confirm": false
}

Примеры кода

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