Метод GetInfo
Примените метод GetInfo для получения настройках ресурса карусели.
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/carousel/v1/GetInfo
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| auth_number | string | авторизационный номер карусели |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| application_uuid | string | идентификатор приложения, в котором создана эта карусель |
| create_date | string | дата создания карусели |
| auth_number | string | авторизационный номер карусели |
| name | string | наименование ресурса карусели (от 3 до 40 символов) |
| number_pool | array | список номеров этого приложения для ротации при исходящем обзвоне |
| regional_number_pool | array RegionalNumberPool | структура номеров с группировкой по региону — только для каруселей с ротацией по региону |
| number_count | uint64 | количество номеров в пуле карусели |
| rotation | enum Rotation | логика ротации при исходящем обзвоне |
| amd | boolean | True — детектирование автоинформаторов подключено, False — детектирование отключено |
RegionalNumberPool
| Параметр | Тип | Описание |
|---|---|---|
| regions | map (dictionary) | структура ключ-значение, в которой ключи — это коды регионов, значения — списки номеров |
| default_number_pool | array | список номеров в дефолтном пуле |
Map
| Параметр | Тип | Описание |
|---|---|---|
| key | string | код региона |
| value | array | список номеров региона |
Rotation
| Параметр | Тип | Описание |
|---|---|---|
| 1 | enum | последовательно (номера меняются в порядке, указанном в параметре number_pool) |
| 2 | enum | случайно (номера меняются в случайном порядке) |
| 3 | enum | случайно по региону (номера подбираются так, чтобы их регион совпадал с регионом принимающего абонента) |
Примеры
Входные параметры:
{
"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
}
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad request | carousel with this auth_number not found | карусель с таким авторизационным номером не найдена |