gethttps://{ourserver.com}/api/resellers/takeOffNumbers

GET /api/resellers/takeOffNumbers

Получить информацию о доходе номеров

Этот запрос опционален, Вы можете не реализовывать данный метод. Запрос возвращает информацию о доходе Ваших текущих номеров, эти данные также доступны в Вашем личном кабинете. При переданном параметре sum, возвращает список номеров аккаунта находящихся онлайн, чей доход превышает переданное значение.

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

Параметры

query2

Название	Тип	Описание
`sum`	`string`	Фильтр по значению дохода, в рублях. Например: при sum = 37.5, запрос вернет список активных номеров, чей доход равен или превышает 37.5 рублей. Если переданное значение равно 0, сервер вернет список всех номеров аккаунта, которые находятся онлайн. По умолчанию:`50`
`test`	`string`	Опциональное поле для тела запросов Reseller API v2. Может принимать одно из двух значений: `test1` или `test2`. Будучи равным `test1` отправит запрос на сервер, но данные, переданные таким запросом не будут сохранены нашим сервером (не вызовет исполнения функции). Если параметр будет равен `test2`, то сервер Onlinesim в ответе вернет тело Вашего запроса. Может передаваться как query-параметр (для GET) или как поле в теле запроса (для POST). Оба способа эквивалентны, но одновременно использовать их не рекомендуется. Перечисление:`test1test2`

header1

Название	Тип	Описание
`Authorization`*	`string`	Смотрите подробнее тут

Ответы

200

Ответ сервера Onlinesim

Content-Typeapplication/json

Схема

Responseobject

responseoneOf

1, если запрос был выполнен успешно, либо выведет сообщение об ошибке

Одно из

[0]string

[1]integer

listobject[]

itemsobject

idstring

ID номера

numberstring

Номер телефона в международном формате

sumstring

Общая сумма дохода, заработанная номером

countrystring

Код страны (согласно списку стран)

Примеры

Example response of Onlinesim server for takeOffNumbers request17 строк

{
  "response": 1,
  "list": [
    {
      "id": "40516575",
      "number": "2203830000",
      "sum": "75.76",
      "country": "220"
    },
    {
      "id": "40516576",
      "number": "2203830001",
      "sum": "58.76",
      "country": "220"
    }
  ]
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

401

Не авторизован. В запросе отсутствует или использован некорректный API-ключ. Некоторые эндпоинты могут возвращать статус 200 с сообщением ERROR_WRONG_KEY вместо 401 — проверяйте тело ответа

Content-Typetext/plain

Схема

Responsestring

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

403

Доступ запрещен. Запрос был понят сервером, но отклонён из-за недостаточных прав доступа

Content-Typeapplication/json

Схема

Responseobject

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

statusinteger

HTTP код ответа в текстовом формате

codestring

messagestring

Возможные коды ошибок: - ERROR_DISABLED - аккаунт партнера не активирован - ERROR_IP - IP адрес не находится в списке разрешенных - allowlist (см. <поле 0="code" 1="{}" 2="Access from IP"> ) - ERROR_RENT - аккаунт не имеет доступа к аренде

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

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

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

detailsobject[]Обязательный

itemsobject

Примеры кода

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