gethttps://onlinesim.io/api/getTariffs.php

GET /api/getTariffs.php

Получить информацию о тарифах на услугу "Прием SMS"

Этот запрос позволяет получить информацию о тарифах на услугу "Прием SMS".

По своей сути является репрезентацией списка сервисов (блока "Купить номер"), расположенного в личном кабинете.

Список сервисов

Параметры

query7

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

Ответы

200

Успешный ответ (с response: "1") или ошибка (с response: "ERROR_CODE")

Content-Typeapplication/json

Схема

ResponseoneOf

Успешный ответ на getTariffs или общая ошибка

Одно из

[0]object

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

"1", если запрос был выполнен успешно, либо выведет сообщение об ошибке. Обработку общих ошибок смотри в разделе Обработка исключений

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

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

Карта стран. Ключи — коды стран с префиксом _ (например, _7, _380)

[additionalProperties]object

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

Название страны для отображения в интерфейсе

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

Имя страны, необходимое при заказе номера. Доступные значения указаны в <ответе >

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

Международный телефонный код страны

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

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

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

Доступность сервиса "Другие сайты" для этой страны

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

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

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

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

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

Карта сервисов для выбранной страны. Ключи — slug сервисов с префиксом _ (например, _vkcom, _telegram)

[additionalProperties]object

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

ID сервиса (место в списке по умолчанию, служебное поле)

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

Количество доступных номеров для данного сервиса

≥ 0

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

Цена сервиса. При использовании locale_price — в валюте баланса

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

Полное название сервиса

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

Короткий ключ сервиса, необходимый для заказа

favorite_countriesobject

Избранные страны (пусто, если клиент не авторизован)

favorite_servicesobject[]

Избранные сервисы (пусто, если клиент не авторизован)

itemsobject

pageinteger

Текущая страница пагинации сервисов

≥ 1

countryinteger

Выбранный код страны (совпадает со значением в запросе)

filterstring

Строка фильтра из запроса

endboolean

true, если сервисов на следующей странице больше нет (конец списка)

favoritesobject

Служебное поле; обычно пустой объект, если избранных сервисов нет

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

Примеры

List of tariffs provided30 строк

Успешный ответ

{
  "response": "1",
  "countries": {
    "_7": {
      "name": "Russia",
      "original": "russia",
      "code": 7,
      "pos": 0,
      "other": false,
      "new": false,
      "enable": true
    }
  },
  "services": {
    "_vkcom": {
      "id": 1,
      "count": 3721,
      "price": "0.55",
      "service": "VKontakte",
      "slug": "vkcom"
    }
  },
  "favorite_countries": {},
  "favorite_services": [],
  "page": 1,
  "country": 7,
  "filter": "",
  "end": false,
  "favorites": {}
}

Примеры кода

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