Onlinesim API

1.0

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

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

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

Это API доступно только для зарегистрированных пользователей Onlinesim!
Вам необходимо зарегистрировать профиль 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 - возвращает подробную информацию о списке доступных стран, бесплатных номеров и сообщений, которые они приняли.

Каждый запрос содержит свое описание, тип, 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 Доступ с этого IP-адреса отключен в настройках профиля
WARNING_LOW_BALANCE Недостаточно средств на балансе

Серверы