POST{yourserver}/getServicesRent

Получить список доступных сервисов и стран для аренды

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

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

Параметры

header1
НазваниеТипОписание
Authorization*string

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

Тело запроса

Тело запроса от сервера Onlinesim

Content-Typeapplication/json
Схема
schemaobject
actionstringОбязательный

Имя метода, в данном случае GET_SERVICES

Перечисление:GET_SERVICESПо умолчанию:GET_SERVICES
keystringОбязательный

API ключ Вашего профиля партнера Onlinesim

Примеры

Example payload of Onlinesim server GET_SERVICES request (for rent)
{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Ответы

200

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

Заголовки

НазваниеТипОписание
Content-Typestring

Заголовок Content type и кодировка

Content-Typeapplication/json
Схема
schemaobject
countryListobject[]Обязательный

Список стран с количеством доступных номеров по операторам и сервисам

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

Статус выполнения запроса (SUCCESS или ERROR)

Перечисление:SUCCESSERROR

Примеры

Response example from your server (shared endpoint for rent and single-service activations)example_lines
{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52,
          "rent": 19
        },
        "beeline": {
          "vk": 10,
          "ok": 15,
          "wa": 20,
          "rent": 9
        },
        "megafon": {
          "vk": 0,
          "ok": 10,
          "wa": 32,
          "rent": 10
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132,
          "rent": 21
        },
        "life": {
          "vk": 0,
          "ok": 10,
          "wa": 32,
          "rent": 2
        },
        "vodafone": {
          "vk": 10,
          "ok": 10,
          "wa": 0,
          "rent": 14
        },
        "kyivstar": {
          "vk": 0,
          "ok": 30,
          "wa": 100,
          "rent": 5
        }
      }
    }
  ],
  "status": "SUCCESS"
}
Response example from your server (dedicated endpoint for rent)example_lines
{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "rent": 19
        },
        "beeline": {
          "rent": 9
        },
        "megafon": {
          "rent": 10
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "rent": 21
        },
        "life": {
          "rent": 2
        },
        "vodafone": {
          "rent": 14
        },
        "kyivstar": {
          "rent": 5
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Примеры кода

Генерация примеров...