# 查询朋友圈任务列表
请求方式: GET
请求地址: https://nbd-api.myscrm.cn/bff-nbd-qw-openapi/v1/job/list
请求参数说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
app_id | string | 是 | 企微中台应用 id |
organ_proj_id | string | 否 | 项目id,多个用逗号分隔 |
keyword | string | 否 | 关键字搜索(创建人名称) |
status | int32 | 否 | 任务状态:1-待发送,2-发送中,3-已发送,4-发送失败 5-已停止 |
start_time | string | 否 | 起始时间(预计发送或发送): yyyy-mm-dd hh:ii:ss |
end_time | string | 否 | 结束时间(预计发送或发送): yyyy-mm-dd hh:ii:ss |
user_id | string | 是 | 用户id |
task_name | string | 否 | 任务名称(模糊搜索) |
send_status | int32 | 否 | 成员发送状态:0-全部,1-未开始,2-进行中,3-已完成,4-发送失败,5-已停止 |
pager | object | 否 | 分页信息 |
pager.page | int64 | 否 | 页码 |
pager.page_size | int64 | 否 | 页数 |
pager.total_rows | int64 | 否 | 总数 |
请求参数示例:
{
"app_id": "xxxx",
"organ_proj_id": "xxx",
"keyword": "xxx",
"status": 0,
"start_time": "xx",
"end_time": "xx",
"pager": {
"page": 1,
"page_size": 10,
"total_rows": 30
},
"user_id": "xxx",
"task_name": "xxx",
"send_status": 0
}
返回数据:
{
"list": [
{
"job_id": "xxx",
"creator_id": "xxx",
"creator_name": "xxx",
"send_type": 0,
"job_status": 0,
"send_schedule_time": "xxx",
"send_time": "xxx",
"create_at": "xxx",
"modify_at": "xxx",
"member_count": 0,
"send_member_count": 0,
"attachment": [
{
"type": 0,
"text_content": "xxx",
"img_url": "xxx",
"img_thumbnail_url": "xxx",
"h5_href": "xxx",
"h5_title": "xxx",
"h5_description": "xxx",
"cover_url": "xxx",
"cover_thumbnail_url": "xxx",
"video_url": "xxx",
"ewmp_material_id": "xxx",
"img_oss_path": "xxx",
"cover_oss_path": "xxx",
"video_oss_path": "xxx"
}
],
"task_name": "xxx",
"send_status": 0,
"is_remind": true
}
],
"pager": {
"page": 1,
"page_size": 10,
"total_rows": 30
}
}
返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
list | array | 列表 |
list.job_id | string | 任务id |
list.creator_id | string | 创建人ID |
list.creator_name | string | 创建人名称 |
list.send_type | int32 | 发送方式:1-立即发送,2-定时发送 |
list.job_status | int32 | 任务状态:1-待发送,2-发送中,3-已发送,4-发送失败 |
list.send_schedule_time | string | 定时发送时间,yyyy-mm-dd hh:ii:ss |
list.send_time | string | 实际发送时间,yyyy-mm-dd hh:ii:ss |
list.create_at | string | 创建时间: yyyy-mm-dd hh:ii:ss |
list.modify_at | string | 修改时间: yyyy-mm-dd hh:ii:ss |
list.member_count | int64 | 总成员数 |
list.send_member_count | int64 | 已发送成员数 |
list.task_name | string | 任务名称 |
list.send_status | int32 | 发送状态:1-未开始,2-进行中,3-已完成,4-发送失败 |
list.create_source | int32 | 创建来源:1-企业创建,2-个人创建 |
list.creator_type | int32 | 创建人类型:1-后台登录用户id,2-企微成员id |