Onlinesim API

Общее описание

Это API позволит Вам получить доступ ко всем услугам, предоставляемым Onlinesim:

• прием SMS от одного конкретного сервиса на виртуальный номер;
• аренда виртуального номера для получения SMS от нескольких различных отправителей в течение длительного времени;
• Вы также можете воспользоваться нашими бесплатными номерами, для тестирования функционала сервиса перед покупкой.

Это API доступно только для зарегистрированных пользователей Onlinesim!

Вам необходимо иметь зарегистрированную учетную запись, чтобы получить доступ к этому API. В этой документации мы будем использовать авторизацию по API ключу для простоты, однако помимо этого доступны и другие методы (более подробно о доступных способах авторизации можно узнать в разделе Авторизация).

Прием сообщений от платежных систем, банков и других кредитных организаций недоступен на нашей платформе. Для получения более подробной информации, в том числе о перечне таких сервисов, пожалуйста, ознакомьтесь с Публичной офертой.

Список API запросов

Запросы различаются в зависимости от вида услуги и разбиты по соответствующим подразделам:

Раздел "Профиль"

Данные запросы относятся либо к профилю клиента, либо ко всем предоставляемым Onlinesim услугам одновременно:

• getBalance - возвращает текущий доступный баланс Вашего профиля, замороженный баланс (зарезервированные средства для активных операций, которые вернутся при их отмене) и информацию о доходе по реферальной программе.
• webhook - позволяет Вам установить URI, на который будут пересылаться все сообщения с Ваших активных операций . Это касается как SMS с услуги "Прием SMS", так и с "Аренда номера".

Раздел "Прием SMS"

Позволяет получить номер для приёма неограниченного количества SMS от одного выбранного сервиса в течение короткого промежутка времени (для большинства сервисов — 15 минут). Пожалуйста, обратите внимание, что Вы не можете менять сервис во время операции. Для приема SMS от разных сервисов, Вам необходимо будет заказать новые номера с соответствующими параметрами.

• getTariffs - запрашивает количество доступных номеров, сгруппированных по странам и сервисам (если такие указаны в запросе);
• getNum - заказывает номер выбранной страны для приема SMS от указанного сервиса;
• getState - возвращает подробную информацию обо всех активных номерах Вашего профиля (включая полученные ими SMS-сообщения);
• setOperationRevise - запрашивает следующее полученное этим номером SMS-сообщение из очереди, если первое не содержало необходимый код и/или нужную информацию.
• setOperationOk - меняет статус операции на успешно выполненную и закрывает её.

Раздел "Аренда"

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

• tariffsRent - запрашивает список стран с подробной информацией о тарифах арендны;
• getRentNum - заказывает в аренду номер выбранной страны на указанный срок;
• getRentState - возвращает список номеров Вашего профиля с активной арендой и полученными ими сообщениями;
• extendRentState - продляет аренду выбранного номера;
• closeRentNum - закрывает операцию аренды.

Раздел "Бесплатные номера"

Данное API предоставляет доступ к функционалу по использованию бесплатных номеров Onlinesim, которые можно найти на главной странице сайта.

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

В этом API доступен один универсальный запрос, который позволяет Вам получить доступ ко всей необходимой информации для использования бесплатных номеров:

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

Коллекция запросов для Postman доступна здесь:

Документация в Postman

Каждый запрос содержит свое описание, тип, URL эндпойнта, параметры, примеры тела запроса и ответа. В описании отдельных запросов также может быть указан список специфичных ошибок, получаемых в виде ответа, которые могут появиться при вызове этих методов. Ответы представлены в JSON или TXT формате в зависимости от вызванного метода и результатов.

Обработка исключений

Ответ сервера	Описание
ACCOUNT_BLOCKED	Аккаунт заблокирован
ERROR_WRONG_KEY	Некорректный API ключ
ERROR_NO_KEY	API ключ отсутствует
ERROR_NO_SERVICE	Название сервиса некорректное или отсутствует
REQUEST_NOT_FOUND	Имя вызываемого метода некорректное или отсутствует
API_ACCESS_DISABLED	Доступ к API отключен в настройках профиля
API_ACCESS_IP	Разрешение на доступ к API с текущего IP-адреса отсутствует в настройках профиля
WARNING_LOW_BALANCE	Недостаточно средств на балансе