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 для успешной авторизации.

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

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

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

Параметр Тип Описание
numbers array of uint64 список номеров для добавления в чёрный список
comment string комментарий

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

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

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

Код Статус Пример сообщения Описание
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 не является строкой (не обёрнуто в кавычки)

Примеры

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

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

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

{}

Метод 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
}

Метод GetList

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

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

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

Авторизация

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

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

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

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

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

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

Параметр Тип Описание
numbers NumbersInfo информация о номере
count uint64 количество номеров в ответе
page uint64 номер страницы

NumbersInfo

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

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

Код Статус Пример сообщения Описание
400 Bad Request proto: syntax error (line 2:14): invalid value ф не валидные данные в поле limit
400 Bad Request proto: syntax error (line 2:14): unexpected token , пустое значение в полях limit или offset
400 Bad Request proto: 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"
}

Метод Delete

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
numbers array of uint64 список номеров для удаления из чёрного списка

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

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

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

Код Статус Пример сообщения Описание
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 не является строкой (не обёрнуто в кавычки)
400 Bad Request provided application does not have any numbers in black list associated with it чёрный список пуст

Примеры

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

{
    "numbers": [
        "74951852525"
    ]
}

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

{}

Метод DeleteAll

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

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

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

Авторизация

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

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

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

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

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

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

Примеры

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

{}

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

{}

Метод SetPrompt

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
media_id uid64 уникальный идентификатор загруженного у приложению аудиофайла

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

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

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

Код Статус Пример сообщения Описание
500 Internal Server Error error set prompt in service: error SetPromptBl from bwl_api service: rpc error: code = Unknown desc = error media_id does not exist ресурс с заданным media_id не существует
400 Bad Request “proto: (line 3:1): invalid value for uint64 type: значение параметра media_id не валидно / не задано`

Примеры

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

{
    "media_id": 100970
}

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

{}

Метод GetPrompt

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

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

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

Авторизация

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

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

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

Пустой JSON.

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

Параметр Тип Описание
media_id uid64 уникальный идентификатор загруженного аудиофайла
prompt_name string имя загруженного аудиофайла

Примеры

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

{}

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

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

Метод DeletePrompt

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

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

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

Авторизация

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

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

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

Пустой JSON.

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

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

Примеры

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

{}

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

{}