Check
Метод Check
Примените этот метод, чтобы проверить находится ли номер в чёрном списке. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/list/blacklist/v1/Check
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| number | string | код номера |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| is_exist | boolean | True если номер находится в чёрном списке. False если номера нет в чёрном списке |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | invalid number format | не валидные данные в поле numbers |
| 400 | Bad Request | invalid AddRequest.Numbers[0]: value length must be between 9 and 20 runes, inclusive | пустое поле numbers / некорректное количество символов в поле numbers |
| 400 | Bad Request | proto: (line 3:9): invalid value for string type: 79991112233 | значение поля numbers не является строкой (не обёрнуто в кавычки) |
Примеры
Входные параметры:
{
"number": "74951852525"
}
Выходные параметры:
{
"is_exist":true
}