GetList

Метод GetList

Примените этот метод для получения списка номеров в чёрном списке. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/list/blacklist/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ПараметрТипОпвсание
limituint64лимит выводимых данных
offsetuint64номер строки, с которой начинать выборку (начинается с 0)

Выходные параметры

ПараметрТипОписание
numbersNumbersInfoинформация о номере
countuint64количество номеров в ответе
pageuint64номер страницы

NumbersInfo

ПараметрТипОписание
numberstringкод номера
created_atstringдата добавления номера в чёрный список в формате RFC-3339 / ISO-8601
commentstringкомментарий

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requestproto: syntax error (line 2:14): invalid value фне валидные данные в поле limit
400Bad Requestproto: syntax error (line 2:14): unexpected token ,пустое значение в полях limit или offset
400Bad Requestproto: syntax error (line 3:14): invalid value ыне валидные данные в поле offset

Примеры

Входные параметры:

{
    "limit": 10000,
    "offset": 0
}

Выходные параметры:

{
    "numbers": [
        {
            "number": "74951852525",
            "created_at": "2023-03-10T11:04:00.186Z",
            "comment": "fraud"
        },
        {
            "number": "74991112233",
            "created_at": "2023-03-14T10:04:27.054Z",
            "comment": "fraud"
        },
        {
            "number": "79817425503",
            "created_at": "2023-03-14T10:04:27.054Z",
            "comment": "fraud"
        }
    ],
    "count": "3",
    "page": "1"
}