GetInfo

Метод GetInfo

Примените метод GetInfo для получения настройках ресурса карусели.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/carousel/v1/GetInfo

Авторизация

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

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

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

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

ПараметрТипОписание
auth_numberstringавторизационный номер карусели

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

ПараметрТипОписание
application_uuidstringидентификатор приложения, в котором создана эта карусель
create_datestringдата создания карусели
auth_numberstringавторизационный номер карусели
namestringнаименование ресурса карусели (от 3 до 40 символов)
number_poolarrayсписок номеров этого приложения для ротации при исходящем обзвоне
regional_number_poolarray RegionalNumberPoolструктура номеров с группировкой по региону — только для каруселей с ротацией по региону
number_countuint64количество номеров в пуле карусели
rotationenum Rotationлогика ротации при исходящем обзвоне
amdbooleanTrue — детектирование автоинформаторов подключено, False — детектирование отключено

RegionalNumberPool

ПараметрТипОписание
regionsmap (dictionary)структура ключ-значение, в которой ключи — это коды регионов, значения — списки номеров
default_number_poolarrayсписок номеров в дефолтном пуле

Map

ПараметрТипОписание
keystringкод региона
valuearrayсписок номеров региона

Rotation

ПараметрТипОписание
1enumпоследовательно (номера меняются в порядке, указанном в параметре number_pool)
2enumслучайно (номера меняются в случайном порядке)
3enumслучайно по региону (номера подбираются так, чтобы их регион совпадал с регионом принимающего абонента)

Примеры

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

{
    "auth_number": "883140006687911"
}

Выходные параметры для карусели с последовательной ротацией:

{
    "carousel": {
        "create_date": "2025-11-18T12:23:24Z",
        "auth_number": "883140006687911",
        "name": "Карусель для исходящего обзвона 1",
        "number_count": "2",
        "number_pool": [
            "79995553534",
            "79995553535"
        ],
        "rotation": 1
    }
}

Выходные параметры для карусели со случайной ротацией и подключенным детектированием авотинформаторов:

{
    "carousel": {
        "create_date": "2025-11-18T12:23:24Z",
        "auth_number": "883140006687911",
        "name": "Карусель для исходящего обзвона 2",
        "number_count": "2",
        "number_pool": [
            "79995553534",
            "79995553535"
        ],
        "rotation": 2,
        "amd": true
    }
}

Выходные параметры для карусели с ротацией в случайном порядке в зависимости от региона принимающего абонента:

{
    "carousel": {
        "create_date": "2025-11-18T12:23:24Z",
        "auth_number": "883140006687911",
        "name": "Карусель для исходящего обзвона 3",
        "number_count": "4",
        "regional_number_pool": {
        "regions": {
            "77": {
                "numbers": [
                    "79995553500"
                ]
            },
            "78": {
                "numbers": [
                    "79995553501"
                ]
            }
        },
        "default_number_pool": [
            "79995553599",
            "79995553522"
            ]
        },
        "rotation": 2
    }
}

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

КодСтатусПример сообщенияОписание
400Bad requestcarousel with this auth_number not foundкарусель с таким авторизационным номером не найдена