Личный кабинет
Интернет-магазин
4.6.3 Получение списка кампаний ИО
POST /vpbx/campaign/list
Метод позволяет получить список кампаний ИО, созданных вручную оператором КЦ или при помощи соответствующего запроса к API. В ответе отправляются все поля, включая поля в которых нет данных (null).
Параметры запроса: пустой json.
Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign.
Пример запроса:
POST https://app.mango-office.ru/vpbx/campaign/list
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{}
В результате обработки запроса, формируется и передается массив данных в формате JSON, содержащий список кампаний ИО и код результата:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип | Обяза-тель-ный | Описание |
| 1 | result | Число | Да | Код результата | ||
| 2 | campaigns [] | Массив объектов | Да | Список кампаний | ||
| 2.1 | campaign_id | Число | Да | ID кампании | ||
| 2.2 | line_id | Число | Да | ID исходящей линии | ||
| 2.3 | name | string | Да | Название кампании, максимум 70 символов | ||
| 2.4 | created_by | Объект | Да | Кем добавлена кампания | ||
| 2.4.1 | user_id | Число | Да | Значение user_id для сотрудника | ||
| 2.4.2 | name | Строка | Да | ФИО сотрудника | ||
| 2.4.3 | extension | Строка | Да | Внутренний номер сотрудника | ||
| 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 | Число | Да | Максимальное количество попыток дозвона, если номер занят. Допустимые значения: 1,3,5,10 | ||
| 2.14 | redial_no_answer | Число | Да | Максимальное количество попыток дозвона, если не берёт трубку. Допустимые значения: 1,3,5,10 | ||
| 2.15 | redial_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 | Число | Да | Коэффициент дополнительных вызовов - отношение количества одновременно генерируемых системой попыток дозвона до клиентов к количеству свободных операторов. Допустимые значения: 0.1, 0.5, 0.7, 1, 1.5, 2, 3, 5 | ||
| 2.22 | timer_busy | Число | Да | Ожидание перед повторной попыткой, если номер занят (в секундах). Допустимые значения: 60, 300, 900, 3600 | ||
| 2.23 | timer_no_answer | Число | Да | Ожидание перед повторной попыткой, если не берёт трубку (в секундах). Допустимые значения: 3600, 10800, 43200, 86400 | ||
| 2.24 | timer_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 | antirobot | Булево | Нет | Признак использования услуги "АнтиРобот". Значение по умолчанию – false | ||
| 2.34 | call_processing | Число | Да | Поствызовная обработка, сек. | ||
| 2.35 | status_reason | Число | Да | Причина перехода в статус (поле status): 1 - команда из вне, 2 - выполнена, 3 - expired (faend <= now()), 4 - не попадает в расписание, 5 - пропал "Пинг", 6 - no service, 7 - no balance, 8 - maintanance, 9 - остановлен администратором. | ||
| 2.36 | schema_id | Число | Да | ID схемы распределения | ||
| 2.37 | created | Число | Да | Дата создания кампании в формате unix timestamp (UTC) | ||
| 2.38 | service_type | Число | Да | Тип кампаний. Список чисел от 0 до 2147483647 | ||
| 2.39 | tasks_count | Число | Да | Общее количество заданий (контактов) | ||
| 2.40 | finished_tasks_count | Число | Да | Количество выполненных заданий (контактов) обзвона | ||
| 2.41 | completed | Число | Да | Время завершения кампании в формате unix timestamp (UTC) |
Пример ответа:
{ "result": 1000,
"campaigns":
{
"campaign_id": 1254253,
"line_id": 403429597,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "Рога и Копыта Обзвон",
"start": 1666814400,
"end": 1672516799,
"status": 0,
"priority": 2,
"members": [
"10004",
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"operators": [],
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 900,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 60,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 30,
"status_reason": 1,
"schema_id": null,
"created": 1666870142,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 265,
"finished_tasks_count": 265,
"completed": null
},
{
"campaign_id": 1264308,
"line_id": 403427465,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "ММ Обзвон(ноябрь) ",
"start": 1668369600,
"end": 1672516799,
"status": 0,
"priority": 2,
"members":
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 3600,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 0,
"status_reason": 5,
"schema_id": null,
"created": 1668402895,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 406,
"finished_tasks_count": 406,
"completed": null
},
{
"campaign_id": 1264327,
"line_id": 403429597,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "Рога и Копыта Обзвон(ноябрь) ",
"start": 1668369600,
"end": 1672516799,
"status": 0,
"priority": 2,
"members":
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 3600,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 0,
"status_reason": 1,
"schema_id": null,
"created": 1668404890,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 47,
"finished_tasks_count": 47,
"completed": null
},
{
"campaign_id": 1266248,
"line_id": 403427465,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "Рога и Копыта Обзвон(Ноябрь новый)",
"start": 1668542400,
"end": 1672516799,
"status": 0,
"priority": 2,
"members":
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 3600,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 30,
"status_reason": 1,
"schema_id": null,
"created": 1668628350,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 211,
"finished_tasks_count": 206,
"completed": null
},
{
"campaign_id": 1266247,
"line_id": 403427465,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "ММ Обзвон(Ноябрь новый)",
"start": 1668542400,
"end": 1672516799,
"status": 0,
"priority": 2,
"members":
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 3600,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 30,
"status_reason": 1,
"schema_id": null,
"created": 1668628267,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 2031,
"finished_tasks_count": 2005,
"completed": null
},
{
"campaign_id": 1254251,
"line_id": 403427465,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "ММ Обзвон",
"start": 1667246400,
"end": 1670702399,
"status": 4,
"priority": 2,
"members":
"10200",
"10201",
"10202",
"10203",
"10204",
"10205",
"10206",
"10207",
"10208",
"10209",
"10210",
"10211"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 900,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 60,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 30,
"status_reason": 3,
"schema_id": null,
"created": 1666870097,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 2504,
"finished_tasks_count": 2504,
"completed": 1670702406
},
{
"campaign_id": 1264947,
"line_id": 403429597,
"created_by": {
"user_id": 403425571,
"name": "Евгеньев Евгений",
"extension": "10004"
},
"name": "тест",
"start": 1668456000,
"end": 1668628799,
"status": 4,
"priority": 2,
"members":
"10004"
,
"redial_busy": 3,
"redial_no_answer": 3,
"redial_not_avail": 3,
"timer_busy": 3600,
"timer_no_answer": 1800,
"timer_not_avail": 1800,
"answer_wait": 30,
"add_calls_coef": 1,
"dial_mode": 3,
"call_processing": 0,
"status_reason": 3,
"schema_id": null,
"created": 1668485990,
"sip_trunk_id_operator": null,
"sip_trunk_id_client": null,
"service_type": 8,
"tasks_count": 7,
"finished_tasks_count": 0,
"completed": 1668628799
} ]}
Была ли статья полезна?
Следующая
