-
10周年大促!注册即领300元优惠券
- 注册/登录
该接口用于系统集成,嵌入自有系统中创建活动,返回跳转链接到活动编辑页面。
请求地址 | https://open.rrx.cn/api/v1/work/create | ||
请求方式 | POST | ||
参数说明 | |||
参数名称 | 是否必须 | 类型 | 说明 |
app_key | 是 | string(32) | 人人秀平台分配的AppKey |
time_stamp | 是 | int(11) | 1970-01-01开始的时间戳,精确到毫秒 |
sign | 是 | string(32) | 根据签名算法计算所得,如何计算签名 |
login_id | 是 | string(60) | 登录账号,指定账号下活动。 查看账号 |
tpl_team_guid | 否 | string(6) | 团队模板GUID,根据模板创建,通过模板接口获取 |
type | 否 | int(11) | 团队模板为空时必传,创建空白活动,type活动类型枚举,1:H5;2:互动(抽奖);3:活动专题;4:文章;5:海报 |
share_info | 否 | obj | 设置活动分享信息 |
open_setting | 否 | obj | 设置活动基本设置,互动类型支持 |
share_info参数说明
参数名称 | 是否必须 | 类型 | 说明 |
title | 否 | string(200) | 活动分享标题 |
describe | 否 | string(200) | 活动分享描述 |
share_image_url | 否 | string(200) | 图片地址,会下载到人人秀 |
open_setting参数说明
参数名称 | 是否必须 | 类型 | 说明 |
start_time | 否 | datetime | 互动活动开始时间,格式例如2024-01-01 00:00:00 |
end_time | 否 | datetime | 互动活动结束时间,格式例如2099-10-10 23:59:59 |
open_mp | 否 | int(2) | 开启关注公众号参与,1:开启 |
open_grab | 否 | int(2) | 开启抽奖,1:开启,仅游戏类、答题类活动支持 |
grab_limit | 否 | int(11) | 开启抽奖条件,满足xx分可抽奖 |
grab_prize_list | 否 | array | 新增抽奖列表管理 |
open_points | 否 | int(2) | 开启积分参与,1:开启 |
points | 否 | int(11) | 开启积分参与,每次消耗积分值 |
open_mp | 否 | int(2) | 开启关注公众号参与,1:开启 |
grab_prize_list参数说明
参数名称 | 是否必须 | 类型 | 说明 |
title | 是 | string(60) | 奖品显示名称 |
type | 是 | int(11) | 奖品类型枚举,1:实物奖品;2:红包奖品;6:积分奖品;7:自有奖品;0:非奖品 |
prize_image_url | 否 | string(200) | 图片地址,会下载到人人秀 |
prize_code | 否 | string(10) | type=7时,自有奖品必传,建议对接自有奖品库(需单独按需开启) |
prize_points | 否 | int(11) | type=6时,积分奖品必传,建议对接自有积分接口(需单独按需开启) |
prize_redpack | 否 | obj | type=2时,红包奖品必传 |
prize_win_rate | 是 | float(2) | 奖品中奖概率(0.01~100),所有奖品总概率不超过100 |
prize_count | 是 | int(11) | 奖品数量 |
is_consolation | 否 | int(2) | 安慰奖,仅支持一个,安慰奖不参与计算中奖概率 |
prize_redpack参数说明
参数名称 | 是否必须 | 类型 | 说明 |
redpack_type | 是 | int(11) | 红包类型枚举,1:固定金额;2:随机金额 |
redpack_amount | 否 | float(2) | 选择固定金额时,必须,金额范围(0.1 ~ 200),小于1元红包需单独按需开启 |
redpack_min_amount | 否 | float(2) | 选择随机金额时,必须,单笔随机的最小金额,金额范围(0.1~200) |
redpack_max_amount | 否 | float(2) | 选择随机金额时,必须,单笔随机的最大金额,必须大于最小金额,金额范围(0.1~200) |
redpack_total_amount | 否 | float(2) | 选择随机金额时,必传,该奖品总发放金额 |
返回JSON格式结果 Content-type: application/json | ||
{"result":0,"msg":"","data":{"h5_guid":"","url":""}} | ||
参与名称 | 类型 | 说明 |
result | int(2) | 0表示成功,1表示失败 |
msg | string(100) | 失败时,返回的错误描述 |
data | obj | 详情见data参数说明 |
data参数说明
参与名称 | 类型 | 说明 |
url | string(100) | 编辑活动地址 |
h5_guid | string(6) | 作品GUID |
prize_list | obj | 活动设置的奖品列表 |
prize_list参数说明
参与名称 | 类型 | 说明 |
grab_prize_list | obj | 抽奖奖品列表,详见上面 grab_prize_list 参数说明 |
签名错误,依据签名算法检查签名
签名过期,需要重新生成签名
未登录,表明登录状态过期,重新登录或调用免登录接口
注意:创建集成必须使用和免登录集成同一个iframe容器,以便于保持登录状态一致。代码示例
请求示例
{
"app_key": "96c84928b1dce057d110ea3b3880fc83",
"time_stamp":"1543999047492",
"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",
"tpl_team_guid": "123456",
"type":2,
"share_info ": {
"title": "抽奖活动自定义标题",
"describe": "这里是分享描述内容",
"share_image_url": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TMaE",
},
"open_setting ":{
"start_time": "2024-01-01 00:00:00",
"end_time": "2099-10-10 23:59:59",
"open_mp": 1,
"open_grab":1,
"grab_limit":60,
"grab_prize_list":[{
"title": "5元随机红包",
"type": 2,
"prize_image_url": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TMaE",
"prize_code": "code1",
"prize_redpack": {
"redpack_type": 2,
"redpack_min_amount": 1.0,
"redpack_max_amount": 5.5,
"redpack_total_amount": 100
},
"prize_points": 0,
"prize_win_rate": 100,
"is_consolation": 0,
}],
"open_points":1,
"points":2,
}
}
返回值示例, json格式 Content-type: application/json
{
"result": 0,
"data": {
"h5_guid": "123456",
"url": "https://portal.rrx.cn/p/edit?id=123456#/",
"prize_list": {
"grab_prize_list": [{
"product_id": 122,
"title": "5元随机红包",
"prize_code": "code_1"
}]
},
},
"msg": "ok"
}