gethttps://onlinesim.io/api/getFreeList

GET /api/getFreeList

Получить список бесплатных номеров

В зависимости от параметров возвращает информацию о доступных странах с бесплатными номерами, полученных ими сообщениях и списком запрещенных сервисов.

Без параметров: возвращает список доступных стран с бесплатными номерами, сообщениями, полученным первым номером из этого списка и списком запрещенных сервисов.

С параметром country: возвращает список доступных бесплатных номеров этой страны, сообщений, полученных первым номером из этого списка и списком запрещенных сервисов.

С параметрами country и number: возвращает список SMS-сообщений, полученных этим номером и списком запрещенных сервисов.

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

Параметры

query8

Название	Тип	Описание
`country`	`string`	Код страны (согласно списку стран)
`number`	`string`	Бесплатный номер телефона, без кода страны, входящие SMS которого необходимо отобразить
`page`	`integer` ≥ 1	Номер страницы SMS (по умолчанию — 1) По умолчанию:`1`
`count`	`integer` ≥ 10, ≤ 500	Количество SMS на страницу. Значения меньше 10 приводятся к 10, больше 500 — к 500. По умолчанию — 10 По умолчанию:`10`
`locale`	`string`	Язык контента. По умолчанию совпадает со значением `lang`
`as_country_text`	`string`	Если `yes`, значение `country` в запросе трактуется как slug страны из конфига (например, `moldova`), а не как числовой код Перечисление:`yes`
`with_content`	`string`	Если `yes`, ответ содержит SEO-контент страницы (поле `content`); иначе `content` равен `null` Перечисление:`yes`
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке Перечисление:`frderuenzh`По умолчанию:`ru`

Ответы

200

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

Content-Typeapplication/json

Схема

ResponseoneOf

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

Одно из

[0]object

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

1 — запрос выполнен (даже если бесплатные номера отсутствуют)

Одно из

[0]integer

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

[1]string

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

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

Страны с доступными бесплатными номерами

itemsobject

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

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

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

Человекочитаемое название страны (с учетом локали)

country_originalstring

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

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

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

[additionalProperties]object

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

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

country_originalstring

Slug страны

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

Человекочитаемое время с момента размещения номера (например, «6 дней назад»)

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

Полный номер телефона в международном формате со знаком +

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

Находится ли номер в архиве. Для живых номеров всегда false

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

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

Номер текущей страницы

≥ 1

dataobject[]Обязательный

Список сообщений на текущей странице

itemsobject

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

Текст SMS

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

Имя или номер отправителя

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

Бесплатный номер, получивший SMS (без кода страны)

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

Дата и время получения сообщения

Шаблон:^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

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

Человекочитаемое время с момента получения сообщения

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

Количество сообщений на странице

≥ 10, ≤ 500

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

Общее количество SMS, полученных выбранным номером

≥ 0

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

Номер последней страницы

≥ 0

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

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

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

Код страны выбранного номера

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

HTML-блок: текст публичной оферты и список запрещенных отправителей

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

SEO-контент страницы или null, если параметр with_content не передан

Одно из

[0]string

[1]nullМожет быть null

[1]object

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

Возвращается, когда OAuth-токен не содержит scope free-scope: текст про invalid scope

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

Примеры

Successful response38 строк

Возвращает список бесплатных номеров и полученных ими SMS-сообщений

{
  "response": 1,
  "countries": [
    {
      "country": 7,
      "country_text": "Россия",
      "country_original": "russia"
    }
  ],
  "numbers": {
    "9915584911": {
      "country": 7,
      "country_original": "russia",
      "data_humans": "6 дней назад",
      "full_number": "+79915584911",
      "is_archive": false
    }
  },
  "messages": {
    "current_page": 1,
    "data": [
      {
        "text": "74957982601 received from onlinesim.io",
        "in_number": "***2601",
        "my_number": 9915584911,
        "created_at": "2022-07-24 15:32:14",
        "data_humans": "1 минуту назад"
      }
    ],
    "per_page": 10,
    "total": 6100,
    "last_page": 610,
    "number": "9915584911",
    "country": 7
  },
  "ignore": "<p>…</p>",
  "content": null
}

Примеры кода

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