4.6.2 Получение списка задач и подзадач кампаний
POST /vpbx/v2/campaign/tasks
Метод возвращает задачи (tasks) и подзадачи (subtasks) кампаний ИО, включая поля, в которых нет данных (null). Метод также предусматривает пагинацию.
Примечание: Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign.
Пример запроса:
POST https://app.mango-office.ru/vpbx/v2/campaign/tasks
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"campaign_ids": 79893,
"fields": "alias_all",
"limit": 100,
"cursor": null
}
В результате обработки запроса, формируется и передается массив данных в формате JSON, содержащий данные задач и подзадач, а также - код результата:
Параметры запроса:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип | Обяза-тель-ный | Описание |
| 1 | campaign_ids[] | Массив объектов | Да | Код результата | ||
| 2 | fields | Массив строк | Нет | Список полей, которые необходимо включить в ответ, поля соответствуют первому уровню вложенности JSON объекта задачи. Синоним alias_task включает в себя все поля, кроме subtasks и task_custom_fields. Синоним alias_all включает в себя все поля. По-умолчанию включен alias_task. Возможные значения: "product_id", "point_id", "campaign_id", "task_id", "name", "position", "organization", "number", "duration", "task_status", "task_status_reason", "task_comment", "blocked_until", "task_updated", "operator_id", "task_end", "due_date", "task_created", "region_fias_id", "did_abonent_id", "first_attempt", "last_attempt", "attempts_count", "make_last_attempt", "priority", "postponed", "postponed_at", "timezone", "timezone_enabled", "ignore_client_schedule", "subtasks", "task_custom_fields", "alias_task", "alias_all" | ||
| 3 | limit | Число | Нет | Максимальное количество задач на страницу. Максимальное значение 100. По-умолчанию 10 | ||
| 4 | cursor | Строка | Нет | Курсор для постраничной навигации, определяет смещение выборки задач |
Поля ответа:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип | Обяза-тель-ный | Описание |
| 1 | result | Число | Да | Код результата | ||
| 2 | message | Строка | Нет | Описание ошибки. Возвращается только в случае неудачной обработки запроса | ||
| 3 | cursor | Строка | Нет | Определяет смещение следующей за возвращаемой выборки задач | ||
| 4 | tasks | Объект | Да | Информация о задачах, массив JSON-объектов | ||
| 4.1 | task_id | Число | Нет | Описание ошибки. Возвращается только в случае неудачной обработки запроса | ||
| 4.2 | name | Строка | Нет | Определяет смещение следующей за возвращаемой выборки задач | ||
| 4.3 | task_status | Число | Нет | Информация о задачах, массив JSON-объектов | ||
| 4.4 | number | Строка | Нет | Идентификатор задачи | ||
| 4.5 | duration | Число | Нет | Имя задачи | ||
| 4.6 | task_status_reason | Число | Нет | Состояние задачи | ||
| 4.7 | operator_id | Число | Нет | Номер, на который будет выполняться звонок | ||
| 4.8 | attempts_count | Число | Нет | Продолжительность разговора | ||
| 4.9 | priority | Число | Нет | Причина перехода в статус | ||
| 4.10 | timezone | Число | Нет | Идентификатор оператора, который обслужил задание | ||
| 4.11 | timezone_enabled | Число | Нет | Количество попыток для задания | ||
| 4.12 | product_id | Число | Нет | Приоритет выполнения задания | ||
| 4.13 | point_id | Число | Нет | Временная зона UTC | ||
| 4.14 | campaign_id | Число | Нет | 1 - если включено учитывать регион абонента, 0 - если нет | ||
| 4.15 | task_created | Строка | Нет | Идентификатор продукта | ||
| 4.16 | task_updated | Строка | Нет | Идентификатор поинта | ||
| 4.17 | did_abonent_id | Число | Нет | Идентификатор кампании | ||
| 4.18 | first_attempt | Строка | Нет | Время создания задачи | ||
| 4.19 | last_attempt | Строка | Нет | Время обновления задачи | ||
| 4.20 | make_last_attempt | Булево | Нет | Абонент тарификации используемый для задачи | ||
| 4.21 | postponed | Булево | Нет | Время первой попытки | ||
| 4.22 | ignore_client_schedule | Булево | Нет | Время последней попытки | ||
| 4.23 | task_custom_fields | Объект | Нет | Если true, выполняется только одна попытка дозвона до клиента, после чего задание завершается | ||
| 4.24 | идентификатор_поля: значение_поля | Строка | Нет | Уникальный идентификатор пользовательского поля (int) + значение поля(string) | ||
| 4.25 | subtasks | Объект | Нет | Массив подзадач, массив JSON-объектов | ||
| 4.25.1 | subtask_id | Число | Да | Идентификатор подзадачи | ||
| 4.25.2 | type | Число | Да | Тип подзадачи (0 - звонок, 1 - смс, 2 - whatsapp) | ||
| 4.25.3 | order | Число | Да | Порядок выполнения | ||
| 4.25.4 | region_fias_id | Число | Да | Регион fias клиента | ||
| 4.25.5 | number | Строка | Да | Номер на который надо звонить | ||
| 4.25.6 | one_attempt | Булево | Да | Если true и первая попытка неудачная, подзадача завершается | ||
| 4.26 | postponed_at | Строка | Нет | Время последнего переноса задачи | ||
| 4.27 | region_fias_id | Число | Нет | Регион fias клиента | ||
| 4.28 | due_date | Строка | Нет | Время, до которого необходимо произвести попытку выполнения задачи. Если задача до указанного времени не выполнена, то она завершается с кодом 25 | ||
| 4.29 | task_end | Строка | Нет | Время завершения задачи | ||
| 4.30 | blocked_until | Строка | Нет | Время, до которого необходимо заблокировать выполнение задания | ||
| 4.31 | task_comment | Строка | Нет | Комментарии к заданию | ||
| 4.32 | organization | Строка | Нет | Название организации | ||
| 4.33 | position | Строка | Нет | Должность контактного лица |
Пример ответа:
{
"result": 1000,
"cmd_id": "a99bce305057c096b6c5df10d7a97e09",
"tasks": {
"product_id": 400270422,
"point_id": 10179676,
"campaign_id": 1897267,
"task_id": 1406133592,
"name": "VNK",
"position": "",
"organization": "",
"number": "74999999999",
"duration": 10,
"task_status": 4,
"task_status_reason": 1,
"task_comment": "Тестовый коммент3",
"task_created": "2025.09.26 08:28:12",
"task_updated": "2025.09.26 08:33:07",
"operator_id": 16380268,
"region_fias_id": 76,
"did_abonent_id": 403577608,
"first_attempt": "2025.09.26 08:32:52",
"last_attempt": "2025.09.26 08:32:52",
"attempts_count": 1,
"make_last_attempt": false,
"priority": 1000,
"postponed": false,
"timezone": 3,
"timezone_enabled": 2,
"ignore_client_schedule": false,
"subtasks": [
{
"subtask_id": 519194896,
"type": 0,
"order": 1,
"region_fias_id": 76,
"number": "74992887836"
},
{
"subtask_id": 519194897,
"type": 0,
"order": 2,
"region_fias_id": 23,
"number": "79620769264"
},
"campaign_status",
": 1",
"campaign_service_type",
": 8"
]
}
}
Была ли статья полезна?
Предыдущая
Следующая