post GET_SERVICES (RENT)

https://{yourserver.com}/getServicesRent
v1 rent

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

Для аутентификации будет использован Ваш API ключ партнера, который будет передан в теле запроса.

ВАЖНО! Вы можете добавить информацию о доступных для аренды номерах на тот же endpoint, который Вы используете для приема SMS (GET_SERVICES, v1) или создать отдельный endpoint для аренды.

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

ВАЖНО! operatorMap должен содержать оператора any, количество номеров которого является суммой номеров всех доступных операторов по аренде.

Parameters

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

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

В: header
Схема:
  • string
    Пример: "Bearer apikey"

Global params

Тело запроса

Тело запроса от сервера Onlinesim
Тип содержимого:
application/json
  • Schema
  • Examples
  • object
    Пример: {"action":"GET_SERVICES","key":"string"}
    Свойства:
    • action
      string
      Обязательный
      Имя метода, в данном случае `GET_SERVICES`
      Пример: "GET_SERVICES"
      Перечисление: GET_SERVICES
    • key
      string
      Обязательный
      API ключ Вашего профиля партнера Onlinesim
      Пример: "string"

Ответы

200

Ответ Вашего сервера на запрос `GET_SERVICES` должен быть в следующем формате:
Заголовки
Content-Type
Заголовок `Content type` и кодировка
Схема:
  • string
    Пример: "application/json; charset=utf-8"
    Перечисление: application/json; charset=utf-8
Содержание
Тип содержимого:
application/json
  • Schema
  • Examples
  • object
    Пример: {"countryList":[{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}],"status":"SUCCESS"}
    Свойства:
    • countryList
      array
      Пример: [{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}]
      Items:
      • object
        Пример: {"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}
    • status
      string
      Статус выполнения запроса (`SUCCESS` или `ERROR`)
      Пример: "SUCCESS"
      Перечисление: SUCCESS ERROR