post GET_NUMBER

https://{yourserver.com}/getNumber
v1

Запрос для заказа номера для приема SMS от указанного сервиса.

Данный запрос отправляется на Ваш сервер для заказа номера на 15 минут с указанными параметрами для получения SMS от одного сервиса.

Операция может быть закрыта досрочно (смотри FINISH_ACTIVATION).

ВАЖНО!
Ваш сервер должен выдать номер с заказанными параметрами в течение 10 секунд после получения запроса. Если по истечению этого времени номер не будет выдан, текущий запрос автоматически отменяется.

ВАЖНО!
Как упоминалось в описании, Вам необходимо будет реализовать функционал по исключению масок номеров. Опциональный параметр exceptionPhoneSet может содержать массив с набором масок для исключений. При их наличии (когда параметр передается), Ваш сервер должен исключить из выдачи номера с масками, совпадающими в этом наборе.
Например, при переданном значении [46950] не должны выдаваться номера Швеции, начинающиеся с +46950*

Exception

ВАЖНО!
Номера используемые в одной операции не могут быть использованы в другой до тех пор, пока предыдущая операция не будет завершена (пока не получен запрос FINISH_ACTIVATION).

Queue

Parameters

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

Смотрите подробнее тут

В: header
Схема:
  • string
    Пример: Bearer apiKey
Content-Type
Обязательный
Заголовок `Content type` и кодировка
В: header
Схема:
  • string
    Пример: application/json; charset=utf-8
    Перечисление: application/json; charset=utf-8

Тело запроса

Тело запроса от сервера Onlinesim
Тип содержимого:
application/json
  • Schema
  • Examples
  • object
    Свойства:
    • action
      string
      Обязательный
      Имя метода, в данном случае `GET_NUMBER`
      Пример: GET_NUMBER
      Перечисление: GET_NUMBER
    • country
      string
      Обязательный

      Название страны, enum (смотри список стран)

      Пример: germany
    • operator
      string
      Обязательный

      Название оператора (для примеров смотри список операторов)

      Пример: any
    • service
      string
      Обязательный

      Название сервиса, enum (смотри список сервисов)

      Пример: facebook
    • sum
      number
      Обязательный
      Цена сервиса, в рублях (эта сумма будет начислена на Ваш аккаунт партнера Onlinesim при успешном завершении операции)
      Пример: 40
    • key
      string
      Обязательный
      API ключ Вашего профиля партнера Onlinesim
    • exceptionPhoneSet
      array<integer>

      Список префиксов-исключений для масок номеров, которые НЕ должны выдаваться при запросе номера. Формат: код страны + следующие за ним цифры номера.

      Items:
      • integer
        Пример: 46950

Ответы

200

Ответ Вашего сервера на запрос GET_NUMBER должен быть в следующем формате:

Заголовки
Content-Type
Заголовок `Content type` и кодировка
Схема:
  • string
    Пример: application/json; charset=utf-8
    Перечисление: application/json; charset=utf-8
Содержание
Тип содержимого:
application/json
  • Schema
  • Examples
  • object
    Свойства:
    • number
      integer
      Номер телефона в международном формате, согласно указанным в запросе параметрам
      Пример: 79088081050
    • activationId
      integer
      ID операции (присваивается Вашим сервером)
      Пример: 355
      >= 1
    • status
      string
      Статус выполнения запроса (`SUCCESS` или `ERROR`)
      Пример: SUCCESS
      Перечисление: SUCCESS ERROR