Получить данные и статус номера
GEThttps://{ourserver.com}/api/resellers/checkNumber
Возвращает данные одного из Ваших номеров (включая номера, подключенные через оборудование): статус, доход, сервисы, баны и, по запросу, историю операций.
Запрос также подтверждает, что Ваш сервер работает.
Параметры
query4
| Название | Тип | Описание |
|---|---|---|
number* | string | Номер телефона с кодом страны (необязательный начальный |
with_history | boolean | Добавляет Ваши завершенные операции по номеру в |
as_text | boolean | Возвращает |
test | string | Тестовый режим. Его также можно передать в теле запроса.
Запрос с любым непустым значением Перечисление: test1test2 |
header1
| Название | Тип | Описание |
|---|---|---|
Authorization* | string | Смотрите подробнее тут |
Ответы
200Данные номера с "response": "1", или {"response": "0"}, если у Вас нет такого номера
application/jsonschemaoneOf
[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"
}У Вас нет такого номера
{
"response": "0"
}401API-ключ не передан или не существует. Тело ответа — простой текст Unauthorized.
Запрос с Accept: application/json вместо этого получает HTTP 200 с {"response":"ERROR_WRONG_KEY"}.
text/htmlUnauthorized.Пример:Unauthorized.403Доступ запрещен: API-ключ действителен, но запрос отклонен. Коды ошибок:
ERROR_DISABLED — партнерский аккаунт не активирован;
ERROR_BANNED — партнерский аккаунт заблокирован;
ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;
ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).
ERROR_DISABLED — партнерский аккаунт не активирован;ERROR_BANNED — партнерский аккаунт заблокирован;ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).application/jsonschemaobject
ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTПримеры
Запрос с IP-адреса вне списка разрешенных
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}