Create

Метод Create

Примените метод Create для создания ресурса карусели — укажите название, выберите номера и логику их ротации.

Созданной карусели автоматически присвоится авторизационный номер — выберите его определяемым в настройках SIP ID или Static IP, с которых будете осуществлять исходящий обзвон.

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

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

Авторизация

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

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

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

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

ПараметрТипОписание
namestringнаименование ресурса карусели (от 3 до 40 символов)
number_poolarrayсписок номеров этого приложения для ротации при исходящем обзвоне (минимум — 2 номера, формат — E.164)
default_number_poolarrayструктура номеров с группировкой по региону — только для каруселей с ротацией по региону
rotationenum Rotationлогика ротации при исходящем обзвоне
amdbooleanTrue для подключения детектирования автоинформаторов, False для отключения детектирования

Rotation

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

ВАЖНО! После создания карусели изменить логику ротации нельзя


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

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

Примеры

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

{
    "name": "Карусель для исходящего обзвона 1",
    "number_pool": ["79995553535", "79995553534", "79995553533"],
    "rotation" : 1
}

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

{
    "name": "Карусель для исходящего обзвона 2",
    "number_pool": ["79995553535", "79995553534", "79995553533"],
    "rotation" : 2,
    "amd": true
}

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

{
    "name": "Карусель для исходящего обзвона 3",
    "number_pool": ["79995553545", "79995553544", "79995553543"],
    "default_number_pool": ["79995553599", "79995553598"],
    "rotation" : 3
}

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

{
    "auth_number": "883140006687911"
}

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

КодСтатусПример сообщенияОписание
400Bad requestIncorrect customer type: only companies can create carouselпользователь должен быть юрлицом или ИП
400Bad requestincorrect customer stateпользователь заблокирован
400Bad requestyou have already created 1000 carousels in this applicationуже создано максимальное количество каруселей: 1 000
400Bad requestcarousel with this name already exists in this applicationкарусель с таким названием уже создана в этом приложении
400Bad requestname must contain between 3 and 40 charactersназвание карусели должно быть от 3 до 40 символов
400Bad requestvalue must contain between 2 and 30000 items, inclusiveпул должен содержать от 2 до 30 000 номеров
400Bad requestnumber {number} is already used in another carouselномер в пуле уже используется в другой карусели
400Bad requestvalue length must be 11 digitsномер должен содержать 11 цифр
400Bad requestIncorrect number formatномер должен быть в формате E.164
400Bad requestnumber {number} does not belong to this applicationномер, указанный в пуле, должен принадлежать этому приложению
400Bad requestnumber {number} is written many timesномер в пуле может быть указан только 1 раз
400Bad requestset consistent (1), random (2) or by region (3) rotationзначение rotation может быть только 1, 2 или 3
400Bad requestinvalid value for bool field amd: {value}значение amd может быть только true или false
400Bad requestactivate the automatic machine detection service on this application firstдля подключения amd нужно сначала подключить эту услугу в настройках приложения в ЛК