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

GET /api/resellers/checkNumbers

Получить подробную информацию об указанных номерах телефонов вашего профиля и их статусах

Данный запрос аналогичен запросу checkNumber, но в отличие от него позволяет массово проверять номера на сервере Onlinesim. Он предоставляет подробную информацию об указанных номерах, либо обо всех номерах аккаунта, если не указаны конкретные номера.

Параметры

query2
НазваниеТипОписание
with_historyboolean

Отображение истории операций (при значении true в ответе будет выведена вся история завершенных операций для указанных номеров)

teststring

Опциональное поле для тела запросов Reseller API v2. Может принимать одно из двух значений: test1 или test2.

Будучи равным test1 отправит запрос на сервер, но данные, переданные таким запросом не будут сохранены нашим сервером (не вызовет исполнения функции).

Если параметр будет равен test2, то сервер Onlinesim в ответе вернет тело Вашего запроса.

Может передаваться как query-параметр (для GET) или как поле в теле запроса (для POST). Оба способа эквивалентны, но одновременно использовать их не рекомендуется.

Перечисление:test1test2
header1
НазваниеТипОписание
Authorization*string

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

Тело запроса

Content-Typeapplication/json
Схема
Bodyobject
numbersstring[]
itemsstring

Номер телефона в международном формате (со знаком +)

Ответы

200

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

Content-Typeapplication/json
Схема
Responseobject
responseoneOf

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

Одно из
[0]string
[1]integer
[additionalProperties]object

Объект с данными о каждом номере, где ключ — это номер телефона

idinteger

ID номера

balanceinteger

Баланс номера

country_idinteger

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

errorsinteger

Какое количество раз номер был заказан, но не сумел получить SMS (количество неудачных операций)

numberstring

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

port_idstring

Уникальное имя порта, которое будет отображаться в нашем интерфейсе на странице управления Вашими номерами.

Значение по умолчанию совпадает с номером телефона (значением параметра number)

maxLen: 100
suminteger

Общий доход, полученный данным номером, в рублях

used_serviceobject

Объект, где ключи — это короткие имена (slug) использованных на текущем номере сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent

[additionalProperties]string

Короткое имя сервиса (slug)

banned_serviceobject

Объект, где ключи — это короткие имена (slug) заблокированных на текущем номере сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent

[additionalProperties]string

Короткое имя сервиса (slug)

historyobject[]
itemsobject
numberinteger

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

servicestring

Название сервиса (для операций аренды значение всегда rent)

sumnumber

Сумма дохода по данной операции в рублях (0, если операция была отменена клиентом или SMS не поступило)

created_atstring

Дата и время начала операции (заказа номера клиентом)

updated_atstring

Дата и время последнего обновления информации об операции (если операция закрыта - совпадает с датой и временем закрытия)

historyboolean

Флаг закрытия операции (если true - операция закрыта на момент выполнения запроса)

bannedboolean

Если true, номер заблокирован (блокировка применяется автоматически, после 3 неудачных операций).

Блокировка снимается автоматически раз в 24 часа или по нажатию на кнопку Сброс банов/Clean all banned services на странице PSA.`

reseller_idinteger

ID аккаунта партнера Onlinesim

rentboolean

При значении true, у Вашего аккаунта есть возможность предоставлять номера в аренду

statusinteger

Текущий статус номера, enum:

1 - номер работает

2 - номер загружается на сервер (после добавления в список номеров)

3 - (deprecated)

4 - указанный Вами номер отсутствует на Вашем аккаунте (некорректный номер)

5 - (deprecated)

6 - null, ошибка аренды: данный номер ранее был успешно использован для аренды и больше не будет генерировать доход. Вам необходимо заменить номер на новый.

7 - (deprecated)

Перечисление:123467
status_textstring

Текущий статус номера, текстовое описание

clearableboolean

Доступность функции Сброс банов/Clean all banned services (доступно раз в 24 часа)`

created_atobject
datestring

Дата и время размещения номера

timezone_typeinteger

Часовой пояс времени сервера

timezonestring

Часовой пояс времени сервера (в текстовом формате)

Примеры

Example response from Onlinesim server (successful retrieval with full details)39 строк
{
  "response": "1",
  "234112233445": {
    "id": 110251,
    "balance": 250,
    "country_id": 46,
    "errors": 0,
    "number": "4605091080",
    "port_id": "Port1",
    "sum": 76.25,
    "used_service": {
      "wa": "wa",
      "tg": "tg"
    },
    "banned_service": {
      "fb": "fb"
    },
    "history": [
      {
        "number": 46777666555,
        "service": "rent",
        "sum": 26.6,
        "created_at": "2024-06-11 17:33:26",
        "updated_at": "2024-06-11 17:48:37"
      }
    ],
    "banned": false,
    "reseller_id": 12345,
    "rent": true,
    "status": 1,
    "status_text": "work",
    "clearable": true,
    "created_at": {
      "date": "2024-05-01T12:00:00",
      "timezone_type": 1,
      "timezone": "UTC"
    }
  }
}
Example response from Onlinesim server (successful retrieval with empty history as `with_history` is not passed)31 строк
{
  "response": "1",
  "234112233446": {
    "id": 110252,
    "balance": 100,
    "country_id": 1,
    "errors": 4,
    "number": "15555555555",
    "port_id": "Port2",
    "sum": 0,
    "used_service": {
      "in": "in"
    },
    "banned_service": {
      "wa": "wa",
      "tg": "tg"
    },
    "history": [],
    "banned": true,
    "reseller_id": 12346,
    "rent": false,
    "status": 6,
    "status_text": "rent_error",
    "clearable": false,
    "created_at": {
      "date": "2024-06-01T12:00:00",
      "timezone_type": 1,
      "timezone": "UTC"
    }
  }
}
Example response from Onlinesim server (failed retrieval)
{
  "response": "0"
}
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

Примеры кода

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