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

GET /api/getNum.php

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

Запрашивает номер для приема SMS от выбранного сервиса.

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

По своей сути является аналогом кнопки покупки номера, расположенной в личном кабинете.

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

apikey

BearerAuth

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

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Параметры

query6

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

Ответы

200

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

Content-Typeapplication/json

Схема

ResponseoneOf

Одно из

[0]allOf

Все из

[0]object

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

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

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

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

ID операции

≥ 1

[1]object

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

Номер телефона в международном формате со знаком + (например, +373…)

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

Код страны без + (совпадает со значением в запросе: 7, 46, 373…)

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

Секунд до конца операции (сколько ещё «живёт» номер)

≥ 0

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

Slug сервиса (например, telegram, whatsapp)

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

Человекочитаемое имя сервиса (язык задаётся параметром lang)

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

Текст статуса операции на языке, заданном параметром lang (сразу после выдачи обычно «ждём SMS»)

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

Секунд до разрешения досрочного закрытия без SMS (0 — уже можно). Обычно 120 с, для WhatsApp — 300 с

≥ 0

[1]object

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

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

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

ID операции

≥ 1

[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 getNum response

Успешная выдача номера

{
  "response": 1,
  "tzid": 10000
}

Примеры кода

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