Blacklist API

Blacklist API — программный интерфейс, который позволяет пользователям управлять чёрным списком номеров: добавлять номера, удалять, устанавливать аудиосообщение для них и т.д.

Blacklist API Exolve предлагает пользователям следующие методы для управления чёрным списком:

• Add - добавляет номер в чёрный список;

• Check - проверяет, находится ли номер в чёрном списке;

• GetList - получает список номеров в чёрном списке;

• Delete - удаляет номер из чёрного списка;

• DeleteAll - удаляет все номера из чёрного списка;

• SetPrompt - устанавливает аудиосообщение, которое будет проигрываться абонентам из чёрного списка при звонке;

• GetPrompt - получает информацию об аудиосообщении, которое проигрывается абонентам из чёрного списка при звонке;

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

Решения, где используется Blacklist API

Попробовать бесплатно

Метод Add

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

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

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

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "comment": "fraud",
    "numbers": [
        "74951852525",
        "79817425503",
        "74991112233"
    ]
}

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

{}

Метод Check

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

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

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

Авторизация

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

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

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

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

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

Примеры

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

{
    "number": "74951852525"
}

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

{
   "is_exist":true
}

Метод GetList

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

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

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

Авторизация

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

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

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

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

NumbersInfo

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

Примеры

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

{
    "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"
}

Метод Delete

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

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

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

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "numbers": [
        "74951852525"
    ]
}

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

{}

Метод DeleteAll

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

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

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

Авторизация

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

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

Передайте пустой JSON.

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

Пустой JSON с 200 OK статусом.

Примеры

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

{}

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

{}

Метод SetPrompt

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

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

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

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "media_id": 100970
}

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

{}

Метод GetPrompt

Примените этот метод для получения информации о премедии, установленной для номеров в чёрном списке (аудиосообщение, которое будет проигрываться пользователям из списка при звонке). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

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

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

Авторизация

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

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

Пустой JSON.

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

Примеры

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

{}

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

{
    "media_id": "100970",
    "prompt_name": "sample-3s"
}

Метод DeletePrompt

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

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

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

Авторизация

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

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

Пустой JSON.

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

Пустой JSON с 200 OK статусом.

Примеры

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

{}

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

{}