Метод Update
Примените метод Update для изменения настроек карусели: названия и пула номеров.
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/carousel/v1/Update
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| auth_number | string | авторизационный номер карусели |
| name | string | наименование ресурса карусели (от 3 до 40 символов) |
| number_pool | array | список номеров этого приложения для ротации при исходящем обзвоне |
| default_number_pool | array | структура номеров с группировкой по региону — только для каруселей с ротацией по региону |
| amd | boolean | True для подключения детектирования автоинформаторов, 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
}
Выходные параметры:
{}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad request | carousel with this auth_number not found | карусель с таким авторизационным номером не найдена |
| 400 | Bad request | incorrect customer state | пользователь заблокирован |
| 400 | Bad request | you have already created 1000 carousels in this application | уже создано максимальное количество каруселей: 1 000 |
| 400 | Bad request | carousel with this name already exists in this application | карусель с таким названием уже создана в этом приложении |
| 400 | Bad request | name must contain between 3 and 40 characters | название карусели должно быть от 3 до 40 символов |
| 400 | Bad request | value must contain between 2 and 30000 items, inclusive | пул должен содержать от 2 до 30 000 номеров |
| 400 | Bad request | number {number} is already used in another carousel | номер в пуле уже используется в другой карусели |
| 400 | Bad request | value length must be 11 digits | номер должен содержать 11 цифр |
| 400 | Bad request | Incorrect number format | номер должен быть в формате E.164 |
| 400 | Bad request | number {number} does not belong to this application | номер, указанный в пуле, должен принадлежать этому приложению |
| 400 | Bad request | number {number} is written many times | номер в пуле может быть указан только 1 раз |
| 400 | Bad request | unknown field "rotation" | нельзя изменить значение rotation, для этого создайте новую карусель |
| 400 | Bad request | invalid value for bool field amd: {value} | значение amd может быть только true или false |
| 400 | Bad request | activate the automatic machine detection service on this application first | для подключения amd нужно сначала подключить эту услугу в настройках приложения в ЛК |