4.6.4 Получение информации о кампании
POST /vpbx/campaign
Параметры:
| № | Параметр | Тип | Обязательный | Описание |
|---|---|---|---|---|
| 1 | campaign_id | Число | Да | ID кампании |
| 2 | need_tasks | Булево | Нет | Возвращать ли задачи |
Пример запроса:
POST https://app.mango-office.ru/vpbx/campaign
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"campaign_id": 56919,
"need_tasks": true
}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип данных | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип данных | Обяза-тель-ный | Описание |
| 1 | result | Число | Да | Код результата | ||
| 2 | campaign | Объект | Да | |||
| 2.1 | campaign_id | Число | Да | ID кампании | ||
| 2.2 | line_id | Число | Да | ID исходящей линии | ||
| 2.3 | name | string | Да | Название кампании | ||
| 2.4 | created_by | Объект | Да | Кем добавлена кампания (abonent_id) | ||
| 2.4.1 | user_id | Число | Да | Значение user_id для сотрудника | ||
| 2.4.2 | name | string | Да | ФИО сотрудника | ||
| 2.4.3 | extension | string | Да | Внутренний номер сотрудника | ||
| 2.5 | priority | Число | Да | Приоритет кампании: 1 - важный, 2 - нормальный, 3 - низкий (по умолчанию: 2 - нормальный) | ||
| 2.6 | order | Число | Нет | Порядок выполнения кампании. Допустимые значения: от 1 до 999. | ||
| 2.7 | start | Число | Да | Дата начала кампании в формате unix timestamp (UTC) | ||
| 2.8 | end | Число | Да | Дата окончания кампании в формате unix timestamp (UTC) | ||
| 2.9 | status | Число | Да | Статус кампании: 0 - остановлена, 1 - запланирована, 2 - в работе, 3 - останавливается, 4 - завершена, 5 - обрабатывается, 6 - удаляется | ||
| 2.10 | members [] | Массив строк из чисел | Да | Список внутренних номеров (extension) сотрудников, добавленных в кампанию, без учета статусов в КЦ и настроек в ЛК | ||
| 2.11 | operators [] | Массив чисел | [] | Да | Список abonent_id сотрудников, а также сотрудников-роботов, участвующих в обработке кампании, без учета статусов в КЦ и настроек в ЛК. | ||
| 2.12 | dial_mode | Число | Да | Режим обзвона: 2 (по умолчанию) - одновременно оператору и абоненту; 3 - сначала оператору, потом абоненту; 4 - сначала абоненту, потом оператору; 7 - предиктивный режим обзвона: система на основе данных о ходе кампании определяет возможность дозвона до следующего клиента до того момента, как оператор освободится. | ||
| 2.13 | redial_busy | Число | Да | Устаревший max_redial_count_if_busy Максимальное количество попыток дозвона, если номер занят. Допустимые значения: 1,3,5,10 | ||
| 2.14 | redial_no_answer | Число | Да | Устаревший max_redial_count_if_no_answ Максимальное количество попыток дозвона, если не берёт трубку. Допустимые значения: 1,3,5,10 | ||
| 2.15 | redial_not_avail | Число | Да | Устаревший max_redial_count_if_number_not_avail Максимальное количество попыток дозвона, если номер недоступен. Допустимые значения: 1,3,5,10 | ||
| 2.16 | redial_antirobot_voice_mail | Число | Да | Максимальное количество попыток дозвона в случае, если антиробот распознал голосовую почту, 3 по умолчанию. Допустимые значения: 1,3,5,10 | ||
| 2.17 | redial_antirobot_busy | Число | Да | Максимальное количество попыток дозвона в случае, если антиробот распознал, что клиент разговаривает или занят, 3 по умолчанию. Допустимые значения: 1,3,5,10 | ||
| 2.18 | redial_antirobot_client_hungup | Число | Да | Максимальное количество попыток, если клиент повесил трубку во время анализа антироботом. По умолчанию 1. Допустимые значения: 1,3,5,10 | ||
| 2.19 | redial_antirobot_not_avail | Число | Да | Максимальное количество попыток дозвона 1-10 - если антиробот вернул: номер недоступен. По умолчанию 3. | ||
| 2.20 | answer_wait | Число | Да | Ожидание ответа клиента (в секундах). Допустимые значения: 10, 20, 30, 60 | ||
| 2.21 | add_calls_coef | Число | Да | Устаревший additional_calls_coefficient Коэффициент дополнительных вызовов - отношение количества одновременно генерируемых системой попыток дозвона до клиентов к количеству свободных операторов. Допустимые значения: 0.1, 0.5, 0.7, 1, 1.5, 2, 3, 5 | ||
| 2.22 | timer_busy | Число | Да | Устаревший wait_time_if_busy Ожидание перед повторной попыткой, если номер занят (в секундах). Допустимые значения: 60, 300, 900, 3600 | ||
| 2.23 | timer_no_answer | Число | Да | Устаревший wait_time_if_no_answ Ожидание перед повторной попыткой, если не берёт трубку (в секундах). Допустимые значения: 3600, 10800, 43200, 86400 | ||
| 2.24 | timer_not_avail | Число | Да | Устаревший wait_time_if_number_not_avail Ожидание перед повторной попыткой, если номер недоступен (в секундах). Допустимые значения: 3600, 10800, 43200, 86400, null/0 - (не перезванивать) | ||
| 2.25 | timer_antirobot_voice_mail | Число | Нет | Ожидание перед повторной попыткой в случае, если антиробот распознал голосовую почту (в секундах) | ||
| 2.26 | timer_antirobot_busy | Число | Нет | Ожидание перед повторной попыткой в случае, если антиробот распознал, что клиент разговаривает или занят (в секундах) | ||
| 2.27 | timer_antirobot_client_hungup | Число | Нет | Ожидание перед повторной попыткой, если клиент повесил трубку во время анализа антироботом (в секундах). По умолчанию 0. | ||
| 2.28 | timer_antirobot_not_avail | Число | Нет | Ожидание перед повторной попыткой, если антиробот вернул: номер недоступен (в секундах). 900, 1800, 3600, 7200, 10800, 43200, 86400. По умолчанию 3600. | ||
| 2.29 | sip_trunk_id_operator | Число | Да | ID транка, через который выполняется соединение с оператором | ||
| 2.30 | sip_trunk_id_client | Число | Да | ID транка, через который выполняется соединение с клиентом | ||
| 2.31 | use_auto_substitution_num | Число | Нет | Признак использования услуги "Автоподстановка номеров". Значение по умолчанию – false | ||
| 2.32 | timezone_mode | Число | Нет | Режим учета часового пояса и расписания: 0 - не учитываются часовая зона и расписание; 1 - учитываются часовая зона оператора и клиента, и расписание; 2 - учитываются часовая зона клиента и расписание. По умолчанию 0. | ||
| 2.33 | timezone_enabled | bool | Нет | Устаревший, рекомендуется использовать timezone_mode Правило учета региона абонента. Значение по умолчанию – false | ||
| 2.34 | antirobot | bool | Нет | Признак использования услуги "АнтиРобот". По умолчанию – false | ||
| 2.35 | call_processing | Число | Да | Поствызовная обработка, сек. | ||
| 2.36 | status_reason | Число | Да | Причина перехода в статус (поле status): 1 - команда из вне, 2 - выполнена, 3 - expired (faend <= now()), 4 - не попадает в расписание, 5 - пропал "Пинг", 6 - no service, 7 - no balance, 8 - maintanance, 9 - остановлен администратором | ||
| 2.37 | schema_id | Число | Да | ID схемы распределения | ||
| 2.38 | created | Число | Да | Дата создания кампании в формате unix timestamp (UTC) | ||
| 2.39 | endless | bool | Да | Значение по умолчанию – false. Конечная кампания завершается, если в ней нет задач. Бесконечная кампания не завершается без явной команды. | ||
| 2.40 | tasks [] | Массив | Нет | Задачи кампании | ||
| task_id | Число | Да | Идентификатор задачи | |||
| name | string | Да | Имя клиента, которому адресован звонок | |||
| status | Число | Да | Состояние задачи, число, обязательный | |||
| number | string | Да | Номер, на который будет выполняться звонок | |||
| timezone | Число | Да | Временная зона UTC | |||
| timezone_enabled | Число | Да | 1 если включено учитывать регион абонента, 0, если нет | |||
| attempts_count | Число | Да | Количество попыток для задания | |||
| status_reason | Число | Да | Причина перехода в статус | |||
| position | string | Да | Должность контактного лица | |||
| due_date | Число | Да | Время, до которого необходимо произвести попытку выполнения задачи в формате unix timestamp (UTC) | |||
| organization | string | Да | Название организации | |||
| comment | string | Да | Комментарии к заданию | |||
| operator_id | Число | Да | Идентификатор оператора, который обслужил задание | |||
| record_id | Число | Да | Идентификатор записи разговора | |||
| duration | Число | Да | Продолжительность разговора | |||
| 3 | did_abonent_ids | Массив чисел | Да | Cписок абонентов, телефоны которых участвуют в автокаруселе |
Пример ответа:
{
"result": 1000,
"campaign": {
"campaign_id": 56919,
"line_id": 300207714,
"created_by": {
"user_id": 300185593,
"name": "Николя Николаев",
"extension": "685"
},
"name": "Рога и Копыта Обзвон(январь)",
"start": 1674735900,
"end": 1675182300,
"status": 0,
"priority": 2,
"members": [],
"operators": [],
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 1,
"timer_busy": 900,
"timer_no_answer": 3600,
"timer_not_avail": 0,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 2,
"call_processing": 0,
"status_reason": 1,
"schema_id": null,
"created": 1674723126,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"endless": false,
"tasks": {
"task_id": 11227830,
"name": "Евгеньев Евгений Евгеньевич",
"status": null,
"number": "375291111111",
"timezone": 3,
"timezone_enabled": 0,
"attempts_count": 0,
"status_reason": null,
"position": "Руководитель",
"due_date": "1753357990",
"organization": "Рога и Копыта",
"comment": null,
"operator_id": null,
"record_id": null,
"duration": null
}
}
}
4.6.5 Создание кампании ИО
Содержание
Была ли статья полезна?
Предыдущая