任务详情接口
作者:林王略
接口地址 /api/open/editorPlugin/task/getTaskDetail
请求方式 GET
consumes
produces ["application/json"]
接口描述 获取任务详情, 注:如果有传audid/openId/unionid,则taskRecordList只返回指定用户的任务记录,否则返回全部用户的任务记录
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-Token | 自建应用访问token | header | true | string | |
req | req | body | true | CbTaskDetailReq | CbTaskDetailReq |
schema属性说明
CbTaskDto
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
appInstanceId | 应用实例ID | query | false | integer(int64) | |
nonce | 6位随机字符串 | query | true | string | |
timestamp | unix时间戳(毫秒) | query | true | integer(int64) | |
orgId | 企业ID | query | false | string | |
appId | 作品id | query | true | string | |
taskId | 任务id | query | true | string | |
audid | 客户id (查询用户任务记录条件之一) | query | false | string | |
unionId | wx union id(查询用户任务记录条件之一) | query | false | string | |
openId | wx open id(查询用户任务记录条件之一) | query | false | string |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ApiResponse«TaskDetailDto» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 返回码 | string | |
errorCode | 错误码 | string | |
msg | 返回信息 | string | |
data | 返回数据 | object | TaskDetailDto |
响应示例
{ "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": { "taskId": "", "title": "", "taskSign": "", "preFlag": 0, "taskType": 0, "taskPartakeType": 0, "appId": "", "appTitle": "", "appUrl": "", "taskRecordList": [ { "taskRecordId": , "taskStauts": 0, "userInfo": { "audid": "", "nickName": "", "openId": "", "unionid": "" } } ], "taskTimeConfigDto": { "resetTaskInterval": "", "intervalHour": 0 } } }
响应schema属性说明
TaskDetailDto
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
taskId | 任务id | string | |
title | 任务标题 | string | |
taskSign | 任务标识 | string | |
preFlag | 是否前置任务.0:不是,1:是 | byte | |
taskType | 任务场景.0:线上,1:线下,统一归属为接口回调类型| 2 事件类型 | byte | |
taskPartakeType | 任务参与页面类型 默认为1-线上 2-线下 | integer | |
appId | 作品id | string | |
appTitle | 作品标题 | string | |
appUrl | 作品链接 | string | |
taskRecordList | 任务记录列表 | ArrayList<TaskRecordDto> | |
taskTimeConfigDto | 任务轮询周期设置 | TaskTimeConfigDto |
TaskTimeConfigDto
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
resetTaskInterval | 任务重置时间类型 custom/week/activity/day 自定义 每周 活动期间 每天 | string | |
intervalHour | 任务刷新时间间隔 | integer | |
TaskRecordDto
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
参数名称 | 参数说明 | 类型 | schema |
taskRecordId | 任务记录id | integer | |
taskStatus | 任务状态: 0:未完成.10:任务已经完成,待领取奖品.30:任务流程全部完成 | byte | |
UserInfo | 用户信息 | object | |
UserInfo
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
audid | 客户id | integer(int64) | |
openId | 微信openId | string | |
unionid | 微信unionid | string | |
nickName | 微信昵称 | string |