背景说明：
兔展的h5活动页支持调用外部事件，从而完成内部的【任务玩法】或者【助力玩法】状态变更。
使用说明：
准备工作
a、需要在兔展工作台开通对应的自建应用
1、填写当前应用的名称；
2、选中【事件】的权限；
3、勾选【事件】中的权限；
4、点击保存，等待审核；
b、审核通过后，通过对应自建应用的【应用id】、【授权密钥】来进行接口的请求。
编辑器的配置工作：
1、任务回调的准备——打开编辑器，在任务玩法中，配置任务标识；
2、助力回调的准备——打开编辑器，在助力玩法中，配置助力事件名称、接口标识；
接口对接——任务回调接口：
请求方式 POST
consumes ["application/json"]
produces ["*/*"]
接口描述 phone ,openid,unionid,audid 四个参数至少传一个
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| X-Token | 自建应用访问token | header | true | string | |
| param | param | body | true | CbTaskDto | CbTaskDto |
schema属性说明
CbTaskDto
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appId | 作品id | body | true | string | |
| appInstanceId | 应用实例ID | body | false | integer(int64) | |
| audid | 客户id | body | false | string | |
| cnlDeptId | 传播的部门ID | body | false | string | |
| cnlId | 传播渠道Id | body | false | string | |
| nonce | 6位随机字符串 | body | true | string | |
| openId | wx open id | body | false | string | |
| orgId | 企业ID | body | false | string | |
| phone | 手机号 | body | false | string | |
| taskId | 任务id | body | true | string | |
| timestamp | unix时间戳(毫秒) | body | true | integer(int64) | |
| unionId | wx union id | body | false | string | |
| taskSign | 任务标识 | body | false | string |
响应状态
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ApiResponse«Void» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 100107 | 参数少传了audid,phone,openId,unionId 至少要传一个 |
接口对接——助力回调接口：
请求方式 POST
consumes ["application/json"]
produces ["*/*"]
接口描述 企业级接口，hearer必须携带X-Token
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| X-Token | 自建应用访问token | header | true | string | |
| param | param | body | true | CbHelpDto | CbHelpDto |
schema属性说明
CbHelpDto
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appId | 作品id | body | true | string | |
| appInstanceId | 应用实例ID | body | false | integer(int64) | |
| audid | audid | body | false | string | |
| cnlDeptId | 传播的部门ID | body | false | string | |
| cnlId | 传播渠道Id | body | false | string | |
| identify | 触发标识 | body | false | string | |
| nonce | 6位随机字符串 | body | true | string | |
| openId | wx open id | body | false | string | |
| orgId | 企业ID | body | false | string | |
| phone | 手机号 | body | false | string | |
| saudid | saudid | body | false | string | |
| timestamp | unix时间戳(毫秒) | body | true | integer(int64) | |
| unionId | wx union id | body | false | string |
响应状态
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ApiResponse«Void» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |