Alternative API

1.0

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

Альтернативное API для интеграции с OnlineSIM.

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

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

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

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

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

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

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

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

Эти запросы позволяют Вам использовать виртуальные номера OnlineSIM для приема SMS от одного конкретного сервиса.

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

  • getNumbersStatus - запрашивает количество доступных номеров, сгруппированных по странам и сервисам;
  • getNumber - заказывает номер выбранной страны для приема SMS от указанного сервиса;
  • getStatus - запрашивает список кодов из полученных SMS;
  • getFullSms - запрашивает список полученных SMS с полным текстом с указанного номера;
  • setStatus - меняет статус операции (отменяет заказ, закрывает операцию и т.д.)

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

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

  • getRentServicesAndCountries - запрашивает список стран с доступными для аренды номерами;
  • getRentNumber - арендует номер выбранной страны на указанный срок;
  • getRentList - возвращает список номеров Вашего профиля с активной арендой;
  • getRentStatus - возвращает информацию о текущем статусе арендного номера, а также список полученных сообщений;
  • setRentStatus - закрывает операцию аренды.

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

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

Общие исключения для методов возвращаются в формате TXT.

TEXT_ERROR

TEXT_ERROR Описание
BAD_KEY API ключ неверный или отсутствует
BAD_ACTION Необрабатываемое исключение

Серверы