post GET_SERVICES

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

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

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

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

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

Каждая успешная операция должна уменьшать счетчик количества доступных для этого сервиса номеров на 1. Если операция была отменена или неудачна (SMS не пришло), счетчик остается без изменений.

Результат операции зависит от значения параметра status, переданного в запросе FINISH_ACTIVATION.

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},"#operator_name#":{"#service_name#":0}}}],"status":"SUCCESS"}
    Свойства:
    • countryList
      array
      Пример: [{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0},"#operator_name#":{"#service_name#":0}}}]
      Items:
      • object
        Пример: {"#countryname#":"string","operatorMap":{"any":{"#service_name#":0},"#operator_name#":{"#service_name#":0}}}
    • status
      string
      Статус выполнения запроса (`SUCCESS` или `ERROR`)
      Пример: "SUCCESS"
      Перечисление: SUCCESS ERROR