GetList

Метод GetList

Примените метод GetList для получения списка ресурсов каруселей приложения.

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

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

Авторизация

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

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

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

Передайте следующие параметры в теле запроса в JSON-формате.

ПараметрТипОписание
date_fromstringдата покупки номера в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_tostringдата покупки номера в формате RFC-3339 / ISO-8601, до которой продолжать выборку
namestringнаименование ресурса карусели
auth_numberstringавторизационный номер карусели
limituint64лимит выводимых строк
offsetuint64номер строки, с которой начинать выборку (начинается с 0)
order_by_nameoneof OrderByсортировка по названию
order_by_dateoneof OrderByсортировка по дате создания

OrderBy

ПараметрТипОписание
1enumпо возрастанию
2enumпо убыванию (по умолчанию для даты)

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

ПараметрТипОписание
carouselarray CarouselElementvассив структур каруселей

CarouselElement

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

Примеры

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

{
    "date_from": "2025-10-17T07:51:05Z",
    "date_to": "2025-10-17T23:51:05Z",
    "limit": 10,
    "offset": 1,
    "order_by_name": 1
}

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

{
    "carousel": [
        {
            "application_uuid": "232451a2-01a3-4dfa-b50e-fb2593a85524",
            "create_date": "2025-11-18T12:23:24Z",
            "auth_number": "883140006687974",
            "name": "Карусель с последовательной ротацией 1",
            "number_count": "2",
            "number_pool": [
                "79361074154",
                "79856793157"
            ],
            "rotation": 1,
            "amd": false
        },
        {
            "application_uuid": "232451a2-01a3-4dfa-b50e-fb2593a85521",
            "create_date": "2025-11-18T12:22:11Z",
            "auth_number": "883140006687910",
            "name": "Карусель со случайной ротацией 2",
            "number_count": "2",
            "number_pool": [
                "79995553535",
                "79995553534"
            ],
            "rotation": 2,
            "amd": true
        },
        {
            "application_uuid": "232451a2-01a3-4dfa-b50e-fb2593a85521",
            "create_date": "2025-11-11T10:10:24Z",
            "auth_number": "883140006687911",
            "name": "Карусель с ротацией по региону 3",
            "number_count": "2",
            "regional_number_pool": {
            "regions": {
                "77": {
                    "numbers": [
                        "79995553500"
                    ]
                },
                "78": {
                    "numbers": [
                        "79995553501"
                    ]
                }
            },
            "default_number_pool": [
                "79995553599",
                "79995553522"
            ]
        },
            "rotation": 3,
            "amd": false
        }
    ]
}

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

КодСтатусПример сообщенияОписание
400Bad requestIncorrect auth_number formatневерный формат авторизационного номера