Update

Метод Update

Примените метод Update для изменения настроек карусели: названия и пула номеров.

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

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

Авторизация

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

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

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

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

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

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

200 OK

Примеры

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

{
    "auth_number": "883140006687911",
    "name": "Карусель 1",
    "number_pool": ["79995553535", "79995553530", "79995553529"],
    "amd": true
}

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

{
    "auth_number": "883140006687912",
    "name": "Карусель 2 Региональная",
    "number_pool": ["79995553531", "79995553532", "79995553523"],
    "default_number_pool": ["79995553521", "79995553522"],
    "amd": false
}

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

{}

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

КодСтатусПример сообщенияОписание
400Bad requestcarousel with this auth_number not foundкарусель с таким авторизационным номером не найдена
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 requestunknown field "rotation"нельзя изменить значение rotation, для этого создайте новую карусель
400Bad requestinvalid value for bool field amd: {value}значение amd может быть только true или false
400Bad requestactivate the automatic machine detection service on this application firstдля подключения amd нужно сначала подключить эту услугу в настройках приложения в ЛК