v2

Получить данные и статус номера

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

Возвращает данные одного из Ваших номеров (включая номера, подключенные через оборудование): статус, доход, сервисы, баны и, по запросу, историю операций.

Запрос также подтверждает, что Ваш сервер работает.

Параметры

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

Номер телефона с кодом страны (необязательный начальный + игнорируется)

with_historyboolean

Добавляет Ваши завершенные операции по номеру в history. Параметр работает по наличию: любое значение, даже 0, включает его.

as_textboolean

Возвращает used_service и banned_service строками через запятую. Работает по наличию, как with_history.

teststring

Тестовый режим. Его также можно передать в теле запроса.

  • test1 — запрос выполняется, и ответ приходит как обычно, но изменения в базе данных откатываются. Действия вне базы данных все равно происходят.
  • test2 — запрос не выполняется: ответ — отладочный дамп (HTML, HTTP 200) заголовков и тела запроса в том виде, в каком их получил наш сервер.

Запрос с любым непустым значением test не подтверждает, что Ваш сервер работает.

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

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

Ответы

200Данные номера с "response": "1", или {"response": "0"}, если у Вас нет такого номера
Content-Typeapplication/json
Схема
schemaoneOf
Одно из
[0]objectДанные одного из Ваших номеров.
[1]object

Примеры

withHistoryСтрок: 35

Рабочий номер, запрошенный с with_history

{
  "id": 110251,
  "balance": 0,
  "country_id": 46,
  "errors": 0,
  "number": "4605091080",
  "port_id": "Port1",
  "equipment_id": "2130706433",
  "sum": 26,
  "used_service": {
    "telegram": "tg"
  },
  "banned_service": {
    "whatsapp": "wa"
  },
  "history": [
    {
      "id": 1027,
      "number": 4605091080,
      "service": "telegram",
      "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": "no",
  "status": 1,
  "status_text": "work",
  "clearable": true,
  "created_at": "2024-06-11T14:33:26.000000Z",
  "response": "1"
}
justAddedСтрок: 21

Номер ожидает активации, аккаунт без доступа к аренде

{
  "id": 110252,
  "balance": 0,
  "country_id": 1,
  "errors": 0,
  "number": "15555555555",
  "port_id": "Port2",
  "equipment_id": "2130706433",
  "sum": 0,
  "used_service": {},
  "banned_service": {},
  "history": [],
  "banned": false,
  "reseller_id": 12345,
  "rent": null,
  "status": 2,
  "status_text": "wait",
  "clearable": false,
  "created_at": "2024-06-01T09:00:00.000000Z",
  "response": "1"
}
notFound

У Вас нет такого номера

{
  "response": "0"
}
401API-ключ не передан или не существует. Тело ответа — простой текст Unauthorized. Запрос с Accept: application/json вместо этого получает HTTP 200 с {"response":"ERROR_WRONG_KEY"}.
Content-Typetext/html
Схема
schemastring
Перечисление:Unauthorized.Пример:Unauthorized.
403Доступ запрещен: API-ключ действителен, но запрос отклонен. Коды ошибок:
  • ERROR_DISABLED — партнерский аккаунт не активирован;
  • ERROR_BANNED — партнерский аккаунт заблокирован;
  • ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;
  • ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).
Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Код ошибкиПеречисление:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENT
messagestringОбязательный
Тот же код ошибки

Примеры

ERROR_IP

Запрос с IP-адреса вне списка разрешенных

{
  "response": "ERROR_IP",
  "message": "ERROR_IP"
}

Примеры кода

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