GEThttps://{ourserver.com}/api/resellers/checkNumber

Получить подробную информацию о номере телефона и его статусе

Данный запрос возвращает подробную информацию о номере.

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

Параметры

query3
НазваниеТипОписание
number*string

Номер телефона в международном формате (включая код страны)

with_historyboolean

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

teststring

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

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

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

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

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

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

Ответы

200

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

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

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

Все из
[0]object

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

Примеры

Example response from Onlinesim server (successful retrieval with full details)example_lines
{
  "response": "1",
  "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",
      "history": true
    }
  ],
  "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)example_lines
{
  "response": "1",
  "id": 110252,
  "balance": 100,
  "country_id": 1,
  "errors": 3,
  "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
Схема
schemastring
Перечисление:Unauthorized
403

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

Content-Typeapplication/json
Схема
schemaobject
errorobjectОбязательный
messagestringОбязательный
Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Обязательный

Примеры кода

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