Личный кабинет
Интернет-магазин
4.6.13 Получение информации о задаче кампании ИО
POST /vpbx/task
Параметры запроса:
| № | Параметры | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|
| 1 | task_id | Число | Да | id задания кампании ИО |
| 2 | brief | Булево | Нет | Если передано значение true не будут запрашиваться поля: custom_fields, subtasks. По умолчанию - false. |
Пример запроса:
POST https://app.mango-office.ru/vpbx/task
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"task_id": "2489649"
}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип данных | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип данных | Обяза-тель-ный | Описание |
| 1 | result | Число | Да | Код результата | ||
| 2 | task | Объект | Да | Список задач для кампании, массив JSON-объектов | ||
| 2.1 | campaign_task_id | Число | Да | ID задания | ||
| 2.1 | campaign_id | Число | Да | ID кампании | ||
| 2.2 | name | Строка | Да | Имя клиента, которому адресован звонок. Ограничение - 255 символов | ||
| 2.3 | priority | Integer | Приоритет выполнения звонка. Может иметь значение от 1 до 1000 | |||
| 2.4 | number | Строка | Да | Номер для выполнения звонка. Ограничение - 64 символа | ||
| 2.5 | organization | Строка | Да | Название организации, которой адресован звонок. Ограничение - 255 символов | ||
| 2.6 | position | Строка | Да | Должность человека, которому адресован звонок. Ограничение - 255 символов | ||
| 2.7 | comment | Строка | Да | Комментарий. Ограничение - 1024 символов | ||
| 2.8 | due_date | Число | Да | Время, до которого необходимо произвести попытку выполнения задачи в формате unix timestamp (UTC) | ||
| 2.9 | blocked_until | Число | Да | Заблокировано до (какого-то времени) в формате unix timestamp (UTC) | ||
| 2.10 | custom_fields | Объект ключ-значение | Да | Значение пользовательских полей. Для получения списка пользовательских полей, используется метод "Получение списка пользовательских полей". Обязательность зависит от настройки. | ||
| 2.11 | talk_duration | Число | Да | Длительность разговора | ||
| 2.12 | status | Число | Да | Статус: 0 - остановлен, 1 - в очереди, 2 - в работе, 4 - завершен, 6 - удален (по умолчанию: 1) | ||
| 2.13 | status_reason | Число | Да | Причина перехода в статус (поле status): 1 - разговор состоялся; 2 - абонент занят; 3 - абонент не взял трубку; 4 - абонент недоступен; 5 - оператор занят; 6 - оператор не взял трубку; 7 - оператор недоступен; 8 - номер внешнего абонента не существует; 10 - оператор не дождался ответа клиента; 11 - остановлен администратором; 20 - остановлен оператором; 21 - антиробот: абонент недоступен; 22 - антиробот: абонент занят; 23 - антиробот: голосовая почта; 24 - клиент повесил трубку во время анализа антироботом; 26 - номер находится в списке запрещённых номеров; | ||
| 2.14 | transfer_number | Строка | Да | Внутренний номер | ||
| 2.15 | updated | Число | Да | Время обновления (например, сменился статус) в формате unix timestamp (UTC) | ||
| 2.16 | end | Число | Да | Окончание действия задачи, после которой она не актуальна (заполняется для задач виджета ОЗ, для задач по ИО значение null), unix timestamp (UTC) | ||
| 2.17 | created | Число | Да | Дата создания в формате unix timestamp (UTC) | ||
| 2.17.1 | subtasks [] | Массив объектов | Да | Массив подзадач (JSON-объектов) с альтернативными номерами клиента, необходимый для того, чтобы в кампанию Исходящего Обзвона можно было добавить информацию о нескольких номерах клиента. В процессе обзвона, в случае дозвона по хотя бы одному из номеров клиентов - обзвон будет остановлен | ||
| 2.17.2 | number | Строка | Да | Номер для выполнения звонка. Ограничение - 64 символа | ||
| 2.17.3 | priority | Число | Да | Приоритет выполнения звонка. Допустимые значения: от 1 до 999. По умолчанию - 1000. | ||
| 2.17.4 | order | Число | Да | Подзадачи располагаются в ответе по возрастанию, в порядке, соответствующему значению поля order, отсчет нумерации всегда начинается с нуля (0). Ограничение - 255 символов | ||
| 2.17.5 | type | Число | Да | Фиксированное значение поля - ноль (0). Ограничение - 255 символов | ||
| 2.17.6 | subtask_id | Число | Да | ID подзадачи кампании |
Пример ответа:
{ "result": 1000,
"task": {
"campaign_task_id": 11227830,
"campaign_id": 56919,
"name": "Евгеньев Евгений Евгеньевич",
"priority":"1",
"position": "Руководитель",
"organization": "АБВ",
"number": "375291111111",
"talk_duration": null,
"status": 1,
"status_reason": null,
"comment": "",
"due_date": "1753358659",
"blocked_until": null,
"transfer_number": null,
"updated": 1674723162,
"end": null,
"created": 1674723162,
"custom_fields": null,
"subtasks":
{
"order": 0,
"number": "+72527954828",
"type": 0,
"subtask_id": 232395
},
{
"order": 2,
"number": "sip:admin@test.mangosip.ru",
"type": 0,
"subtask_id": 232396
}
}
