Метод Create
Примените метод Create для создания ресурса карусели — укажите название, выберите номера и логику их ротации.
Созданной карусели автоматически присвоится авторизационный номер — выберите его определяемым в настройках SIP ID или Static IP, с которых будете осуществлять исходящий обзвон.
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/carousel/v1/Create
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| name | string | наименование ресурса карусели (от 3 до 40 символов) |
| number_pool | array | список номеров этого приложения для ротации при исходящем обзвоне (минимум — 2 номера, формат — E.164) |
| default_number_pool | array | структура номеров с группировкой по региону — только для каруселей с ротацией по региону |
| rotation | enum Rotation | логика ротации при исходящем обзвоне |
| amd | boolean | True для подключения детектирования автоинформаторов, False для отключения детектирования |
Rotation
| Параметр | Тип | Описание |
|---|---|---|
| 1 | enum | последовательно (номера меняются в порядке, указанном в параметре number_pool) |
| 2 | enum | случайно (номера меняются в случайном порядке) — применяется по умолчанию |
| 3 | enum | случайно по региону (номера подбираются так, чтобы их регион совпадал с регионом принимающего абонента) |
ВАЖНО! После создания карусели изменить логику ротации нельзя
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| auth_number | string | авторизационный номер карусели |
Примеры
Входные параметры для карусели с последовательной ротацией:
{
"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"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad request | Incorrect customer type: only companies can create carousel | пользователь должен быть юрлицом или ИП |
| 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 | set consistent (1), random (2) or by region (3) rotation | значение rotation может быть только 1, 2 или 3 |
| 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 нужно сначала подключить эту услугу в настройках приложения в ЛК |