调用本接口查询任务列表,包括触达任务详情、流程画布详情等数据。
基本信息
- 接口 path:/gmp/openapi/v1/task/list_task_by_page
- 请求方式:POST、application/json
请求参数
参数 | 类型 | 是否必填 | 描述 |
|---|
task_status | int | 否 | 任务状态 |
task_type | string | 是 | 任务类型。 |
page_no | int | 是 | 页数 |
page_size | int | 是 | 页大小,最大限制是 10 |
mode | int | 否 | 任务模式 Mode_SINGLE Mode = 1
Mode_CYCLIC Mode = 2
Mode_FINISH_A Mode = 3
Mode_FINISH_A_UNFINISH_B Mode = 4
Mode_PERSONALIZED_TIME Mode = 5
Mode_TimeTagScheudle Mode = 7
Mode_PUBLIC_PERSONALIZATION_TIMING_SINGLE Mode = 8
Mode_PUBLIC_PERSONALIZATION_TIMING_CYCLIC Mode = 9
|
channel | int | 否 | 通道类型 ChannelType_SMS ChannelType = 1
ChannelType_PUSH ChannelType = 2
ChannelType_WEBHOOK ChannelType = 3
ChannelType_H5_WINDOW ChannelType = 4
ChannelType_WECHAT_SERVICE ChannelType = 5
ChannelType_WECHAT_ACTIVE ChannelType = 6
ChannelType_APP_WINDOW ChannelType = 7
ChannelType_DOUYIN ChannelType = 9
ChannelType_WECHAT_MASS ChannelType = 10
ChannelType_WEBHOOKB ChannelType = 11
ChannelType_CarMachine ChannelType = 12
ChannelType_ScrmCustomer ChannelType = 13
ChannelType_ScrmGroup ChannelType = 14
ChannelType_ScrmWelcome ChannelType = 15
ChannelType_ScrmMoment ChannelType = 16
ChannelType_WechatAppletSubscribeMsg ChannelType = 17
ChannelType_MiniProgramPopup ChannelType = 18
ChannelType_SCRMManualAddCustomer ChannelType = 19
ChannelType_MultiMiniProgramPopup ChannelType = 20
ChannelType_ScrmStaffManage ChannelType = 101
ChannelType_ResourceSpace ChannelType = 102
ChannelType_RecResourceSpace ChannelType = 103
|
task_group_id | int64 | 否 | 任务分组id |
creator | string | 否 | 创建人 |
name | string | 否 | 任务名 |
channel_id | int64 | 否 | 通道id |
sort_config | object | 否 | 排序方式,选填 SortField.SortField 仅支持 RecentReachRate/TotalReachRate/MmgDoneRate |
sort_config.field_name | string | 否 | 按照哪一列排序 |
sort_config.sort_type | int64 | 否 | 升降序 SortType_Incr SortType = 1
SortType_Desc SortType = 2
|
app_id | int64 | 否 | 项目 ID |
res_group_ids | list | 否 | 资源组筛选列表 |
creators | list | 否 | 创建人筛选列表 |
user_id | int64 | 否 | 登录用户 ID,不填则不会判断当前登陆人是否能够审批该任务 |
task_id_ref_by_event_attr | int64 | 否 | 不传或传 0 表示不过滤 |
task_type_ref_by_event_attr | int64 | 否 | task/canvas/smart_task 不传或传空表示不过滤 |
subject_id | int64 | 否 | 主体 ID |
id | int64 | 否 | 任务 ID |
campaign_id | int64 | 否 | 活动 ID |
create_start_time | int64 | 否 | 开始时间(用于创建时间的筛选) |
create_end_time | int64 | 否 | 结束时间(用于创建时间的筛选) |
show_scrm | bool | 否 | 是否展示企微通道任务 |
scrm_task_types | int64 | 否 | 企微任务类型 SCRMTaskType_AddCustomerSMS SCRMTaskType = 1
SCRMTaskType_AddCustomerManual SCRMTaskType = 2
SCRMTaskType_SendCustomer SCRMTaskType = 3
|
market_plan_id | int64 | 否 | 营销计划 ID |
market_plan_crowd_id | int64 | 否 | 营销计划人群 ID |
third_push_type | int64 | 否 | Volc = 0 // 火山
JiGuang = 1 // 极光
|
task_status_list | list | 否 | 支持根据多个任务状态筛选 TaskStatus_DRAFT TaskStatus = 1
TaskStatus_WAIT_APPROVE TaskStatus = 2
TaskStatus_APPROVED TaskStatus = 3
TaskStatus_PAUSE TaskStatus = 4
TaskStatus_OVER TaskStatus = 5
TaskStatus_CANCEL TaskStatus = 6
TaskStatus_ABNORMAL TaskStatus = 7
TaskStatus_REJECT TaskStatus = 8
TaskStatus_DELETE TaskStatus = 9
TaskStatus_Fail TaskStatus = 10
TaskStatus_Template TaskStatus = 11
TaskStatus_SubTaskAbnormal TaskStatus = 100
|
name_or_id | string | 否 | 任务名/任务 ID 筛选,会覆盖模糊 ID 查询的 ID 和名字 |
is_sub_task_abnormal | bool | 否 | 筛选子任务部分异常的任务 |
multi_group_id_list | list | 否 | 多级分组 ID |
响应参数
参数 | 类型 | 描述 |
|---|
code | int32 | 错误码,正常返回0 |
data | object | 查询的任务列表 |
msg | string | 结果信息 |
log_id | string | trace |
touch_task_list | list<touch_task> | 参数详情请参见touch_task |
process_canvas_list | list<process_canvas> | 参数详情请参见process_canvas |
total_count | int64 | 总记录数 |