任务组件（新）

> 将用户在其自己平台中的行为（如注册、浏览、使用、下单、支付等）打包为任务和成就，通过运营构建任务和成就体系，来引导用户的活跃和转化。通过完成任务，用户可以获得抽奖次数、游戏次数、养料等奖励，从而增加互动活动的乐趣和参与度。

## 制作流程
1. 定义任务模板：在控制台-应用管理-H5编辑器-任务库-添加
![](/media/202305/2023-05-19_111526_1228540.09334951759902876.gif)
2. 制作一个H5作品并选择任务组件：H5编辑器-玩法

3. 制作一个互动作品并选择第二步制作好的作品
![](/media/202305/2023-05-19_112506_4533050.018826034103199607.gif)
</div>
4. 发布互动活动。<span style="color: red">特别注意：一旦互动作品发布后就不要增减第二步制作好的任务组件，仅可以调整样式</span>
5. 用户参与互动活动并接收任务

6. 用户完成任务并领取奖励。当用户完成任务后，任务状态变为“待领取”，点击“领取”按钮获取任务奖励。

## 任务分类

### 内置任务
系统目前内置了两种任务：
1. 签到：通过让用户在任务周期内（如：每天、每周等）签到，以获取奖励。

2. 转发：通过让用户转发活动来获取奖励，只要在一个互动活动内关联了转发任务组件，当用户在微信内转发活动就会完成该任务并领取对应奖励。

### 自定义任务
#### 普通任务
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;自定义任务是根据具体需求自定义的任务类型。与内置任务不同，自定义任务可以根据不同的业务需求，自由定义任务的名称、描述、奖励和完成条件等信息。
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;自定义任务的完成有两种方式：
- 推送进度
需要第三方系统调用接口(参照“更新任务进度”或“完成任务”)来实现。当用户点击“去完成”任务时，跳转到第三方系统，并且链接上会携带一些与任务相关的参数，用于用户完成后调用接口完成任务。跳转链接示例：
```
https://www.baidu.com?encodeId=5c02bfa5bee54831a372b565d9eeeb63&taskCode=skyKFPQm4sSE&mixCreationId=157503&eqsRedirectUrl=https%3A%2F%2Fwww.eqxiu.cn%2Fv%2F157503%3Fcc%3DdunsBEa7
```
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| mixCreationId | 是 | Long | 互动作品id |
| taskCode | 是 | String | 任务编号 |
| encodeId | 是 | String | 用户标识 |
| eqsRedirectUrl | 是 | String | 活动链接，可用于第三方系统完成任务后跳回活动 |
- 拉取进度
第三方系统提供接口（参照“拉取任务进度”），由内容中台主动拉取。配置地址：
![](/media/202401/2024-01-18_154125_8623130.9377017706845209.png)
#### 稿件任务
适用于阅读稿件等任务，阅读指定新闻列表后领取奖励的场景（类似场景也支持，比如自选股票基金等），需要对接两个接口，第一个是[查询稿件列表](https://hc.eqxiu.cn/doc/3205/ "查询稿件列表")、第二个是查询任务的完成进度
![](/media/202504/2025-04-09_153514_5551380.49530323134540877.png)

## 接口规范
### 更新任务进度
- 接口描述：更新任务进度，如果任务数据达到任务设置的条件则完成任务
- 接口地址：/api/v1/editor/task/progress/push?token=TOKEN
- 请求方式：POST
- Content-Type：application/json
- 接口入参：
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| mixCreationId | 是 | Long | 当前活动作品id |
| taskCode | 是 | String | 任务编号 |
| encodeId | 是 | String | 用户标识 |
| taskData | 否 | json | 任务数据，数值型任务需要 |
- 备注：mixCreationId取值：互动作品内嵌入H5任务作品，此时的值为互动作品id；单独的H5任务作品，此时的值为H5作品id
- 请求示例
```
{
    "mixCreationId": 106335,
    "taskCode": "na3AcWzQ9Dkw",
    "encodeId": "1093614b4dbc44eaa3369d8ff06578c9",
    "taskData": {
      "data": {
        "repostNum": 501 //任务库选择数值型时设置的key
      }
    }
}
```

- 返回值说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| isComplete | Boolean | 是否完成任务 |

- 返回示例
```json
{
	"success": true,
	"code": "200",
	"msg": null,
	"obj": {
		"isComplete": true
	},
	"map": null,
	"list": null,
	"details": null
}
```

### 完成任务
- 接口描述：直接完成任务
- 接口地址：/api/v1/editor/task/complete?token=TOKEN
- 请求方式：POST
- Content-Type：application/json
- 接口入参：
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| mixCreationId | 是 | Long | 当前活动作品id |
| taskCode | 是 | String | 任务编号 |
| encodeId | 是 | String | 用户标识 |
- 备注：mixCreationId取值：互动作品内嵌入H5任务作品，此时的值为互动作品id；单独的H5任务作品，此时的值为H5作品id
- 请求示例
```
{
    "mixCreationId": 106335,
    "taskCode": "na3AcWzQ9Dkw",
    "encodeId": "1093614b4dbc44eaa3369d8ff06578c9"
}
```

- 返回示例
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null,
    "details": null
}
```

### 拉取任务进度
- 接口描述：主动拉取任务
- 请求方式：POST
- Content-Type：application/json
- 接口入参：
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| timestamp | 必须 | String | 请求时的时间戳 |
| nonce | 必须 | String | 随机字符串 |
| signature | 必须 | String | 请求签名 |
| msgEncrypt | 必须 | String | 加密后的消息 |

- msgEncrypt内容如下：
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| defCreationId | 是 | Long | H5作品id |
| mixCreationId | 是 | Long | 当前活动作品id |
| taskDefineId | 是 | Long | 任务定义id（任务库定义的任务） |
| elementId | 是 | Long | 任务组件id |
| startTime | 是 | Date | 当前任务周期开始时间 |
| endTime | 是 | Date | 当前任务周期结束时间 |
| thirdUserId | 否 | String | 自定义授权用户id |
| thirdOpenId | 否 | String | 微信授权openId |
| mobile | 否 | String | 手机号 |
| customParams | 否 | JSON | 自定义参数对象 |
| taskIdentify | 否 | String | 任务标识（任务定义时由用户自定义） |
| authType | 是 | Int | 授权类型 1-微信授权 2-手机授权 3-自定义授权 |

- 接口出参：
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| obj.data | 是 | Object | 注意数值型和有无型数据格式不同|

- 返回示例
数值型：
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": {
        "data": {
            "repostNum": 1 //任务库选择数值型时设置的key
        }
    }
}
```
有无型：
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": {
        "data": 1 // 返回当前周期内完成次数
    }
}
```
## 触发自定义js
```javascript
(function() {
    return (...args) => {
	console.log(args)
        const {defCreationId,
            mixCreationId,
            taskDefineId,
            elementId,
            thirdOpenId,
            thirdUserId,
            mobile,
            authType,
            encodeId,
			// 任务配置额外参数
			params:{
				key:value
			},
			// 任务完成条件配置
			condition:{
				key:value
			}
			} = args[2];
    }
})()
```