post{yourserver}/getServices

POST /getServices

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

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

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

Параметры

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

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

Тело запроса

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

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

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

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

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

Примеры

Example payload of Onlinesim server GET_SERVICES request
{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Ответы

200

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

Content-Typeapplication/json

Заголовки

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

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

Схема
Responseobject
countryListobject[]Обязательный

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

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

Объект, где каждый ключ — это название страны, согласно списку стран

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

Объект, где каждый ключ — это название оператора, согласно списку операторов. Ключ any является обязательным и должен содержать суммарное количество номеров по всем операторам для каждого сервиса

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

Суммарное количество номеров для всех операторов по каждому сервису. Для услуги "Прием SMS" ключи — названия сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent

[additionalProperties]integer

Количество доступных номеров для данного сервиса (или rent)

≥ 0
[additionalProperties]object

Данные о количестве номеров по конкретному оператору (не any). Ключи — названия сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent

[additionalProperties]integer

Количество доступных номеров для данного сервиса у этого оператора

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

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

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

Примеры

Response example from your server50 строк
{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52
        },
        "beeline": {
          "vk": 10,
          "ok": 15,
          "wa": 20
        },
        "megafon": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132
        },
        "life": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        },
        "vodafone": {
          "vk": 10,
          "ok": 10,
          "wa": 0
        },
        "kyivstar": {
          "vk": 0,
          "ok": 30,
          "wa": 100
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Примеры кода

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