任务详情接口

作者:林王略

接口地址 /api/open/editorPlugin/task/getTaskDetail

请求方式 GET


consumes 

produces ["application/json"]

接口描述   获取任务详情, 注:如果有传audid/openId/unionid,则taskRecordList只返回指定用户的任务记录,否则返回全部用户的任务记录

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

X-Token自建应用访问tokenheadertruestring
reqreqbodytrue
CbTaskDetailReq
CbTaskDetailReq

schema属性说明

CbTaskDto

参数名称

参数说明

请求类型

是否必须

数据类型

schema

appInstanceId应用实例IDqueryfalseinteger(int64)
nonce6位随机字符串querytruestring
timestampunix时间戳(毫秒)querytrueinteger(int64)
orgId企业IDqueryfalsestring
appId作品idquerytruestring
taskId任务idquerytruestring
audid客户id (查询用户任务记录条件之一)queryfalsestring
unionIdwx union id(查询用户任务记录条件之一)queryfalsestring
openIdwx open id(查询用户任务记录条件之一)queryfalsestring

响应状态

状态码

说明

schema

200OKApiResponse«TaskDetailDto»
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数

参数名称

参数说明

类型

schema

code返回码string
errorCode错误码string
msg返回信息string
data返回数据objectTaskDetailDto

响应示例

{
  "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任务idstring
title任务标题string
taskSign任务标识string
preFlag
是否前置任务.0:不是,1:
byte
taskType
任务场景.0:线上,1:线下,统一归属为接口回调类型| 2 事件类型
byte
taskPartakeType
任务参与页面类型 默认为1-线上 2-线下
integer
appId作品idstring
appTitle作品标题string
appUrl作品链接string
taskRecordList任务记录列表ArrayList<TaskRecordDto>
taskTimeConfigDto任务轮询周期设置TaskTimeConfigDto


TaskTimeConfigDto

参数名称

参数说明

类型

schema

resetTaskInterval
任务重置时间类型 custom/week/activity/day 自定义 每周 活动期间 每天
string
intervalHour
任务刷新时间间隔
integer






TaskRecordDto

参数名称

参数说明

类型

schema

参数名称

参数说明

类型

schema

taskRecordId任务记录idinteger
taskStatus任务状态: 
0:未完成.10:任务已经完成,待领取奖品.30:任务流程全部完成
byte
UserInfo用户信息object





UserInfo

参数名称

参数说明

类型

schema

audid客户idinteger(int64)
openId微信openIdstring
unionid微信unionidstring
nickName微信昵称string
  • 无标签