帮助中心  /  活动编辑更新接口

活动编辑更新接口

该接口用于系统集成,嵌入自有系统中编辑活动,返回活动编辑页面地址。


接口参数说明

请求地址

https://open.rrx.cn/api/v1/work/edit

请求方式

POST方式,Content-type:application/x-www-form-urlencoded

参数说明

参数名称

是否必须

类型

说明

app_key

string(32)

人人秀平台分配的AppKey

time_stamp

int(11)

1970-01-01开始的时间戳,精确到毫秒

sign

string(32)

根据签名算法计算所得,如何计算签名

login_id

string(60)

登录账号,指定账号下活动   查看账号 

h5_guid

string(6)

作品GUID

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)

开启积分参与,每次消耗积分值

rule_content

text

活动规则,支持富文本,图片不支持

auto_show_rule

int(2)

开启关注公众号参与,1:开启

open_forms

int(2)

开启报名表单,1:开启

forms_list

array

报名表单列表

open_grab_later

int(2)

开启领奖后关注,1:开启(仅支持开启抽奖类活动)

later_info

array

领奖后事件

open_top_prize

int(2)

开启排行榜奖品,1:开启(仅游戏、答题类活动支持)

top_prize_list

array

排行榜奖品列表

get_prize_list

array

任务领奖奖品设置(支持日历抽奖、任务宝、拆礼盒、集字助力活动)

open_black

int(2)

开启禁止黑名单用户参与,1:开启

open_sys_black

int(2)

开启禁止系统不量用户参与,1:开启


grab_prize_list参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

product_id

int(11)

修改奖品的ID,(创建时返回或通过数据接口获取

新增奖品时可为0。

title

string(60)

奖品显示名称

type

int(11)

奖品类型枚举,1:实物奖品;2:红包奖品;6:积分奖品;7:自有奖品;0:非奖品

prize_image_url

string(200)

图片地址,会下载到人人秀

prize_code

string(10)

type=4时,自有奖品必传,建议对接自有奖品库(需单独按需开启)

prize_links

obj

type=7时,自有奖品自定义跳转链接,非API模式必传

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)

安慰奖,仅支持一个,安慰奖不参与计算中奖概率

send_type

int(11)

配送方式,1:直接领取;2:快递发货;3:线下核销

is_delete

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)

选择随机金额时,必传,该奖品总发放金额


prize_links参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

type

int(2)

自有奖品类型,1:跳转链接;2:跳转小程序

links

string(60)

type=1,必传,跳转的自定义链接

appid

string(20)

type=2,必传,跳转的小程序APPID

path

string(60)

type=2,可传,跳转的小程序页面路径,默认首页


later_info参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

type

int(2)

关注类型,1:关注二维码;2:跳转链接;3:跳转小程序

title

string(60)

引导标题

message

string(200)

引导文案

image_src

string(60)

type=1,必传,关注的二维码图片地址

btn_text

string(10)

type=2或type=3,可传,引导按钮文案

link

string(60)

type=2,必传,跳转的链接地址

appid

string(20)

type=3,必传,跳转的小程序APPID

path

string(60)

type=3,可传,跳转的小程序页面路径,默认首页


froms_list参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

title

string(20)

字段显示标题

type

string(10)

字段类型枚举:姓名、手机号、收货信息、文本、多行文本、下拉框

values

string(200)

type=下拉框,必传,选项值多个逗号分割

is_must

int(2)

是否必填,1:必填

is_sms

int(2)

type=手机号,可用,1:开启短信验证

is_only

int(2)

type=手机号,可用,1:开启手机号唯一

is_delete

int(2)

是否标记删除


top_prize_list参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

product_id

int(11)

修改奖品的ID,(创建时返回或通过数据接口获取

新增奖品时可为0。

title

string(20)

奖品显示名称

type

int(11)

奖品类型枚举,1:实物奖;2:红包奖品;6:积分奖品;7:自有奖品;0:非奖品

prize_image_url

string(200)

图片地址,会下载到人人秀

prize_code

string(10)

type=7,自有奖品,开启API必传 

pirze_links

obj

type=7,自有奖品,非API必传,自定义跳转

prize_points

int(11)

type=6,积分奖品,积分分值

prize_redpack

obj

type=2,红包奖品,必传

send_type

int(2)

配送方式,1:直接领取;2:快递发货;3:线下核销

top_num

int(11)

该奖品发奖排行榜开始排名值

top_end_num

int(11)

该奖品发奖排行榜结束排名值

is_delete

int(2)

是否标记删除,若奖品已有领取则不支持删除


get_prize_list参数说明(不传则不更新) 

参数名称

是否必须

类型

说明

product_id

int(11)

修改奖品的ID,(创建时返回或通过数据接口获取

新增奖品时可为0。

title

string(20)

奖品显示名称

type

int(11)

奖品类型枚举,1:实物奖;2:红包奖品;6:积分奖品;7:自有奖品;0:非奖品

prize_image_url

string(200)

图片地址,会下载到人人秀

prize_code

string(10)

type=7,自有奖品,开启API必传 

pirze_links

obj

type=7,自有奖品,非API必传,自定义跳转

prize_points

int(11)

type=6,积分奖品,积分分值

prize_redpack

obj

type=2,红包奖品,必传

send_type

int(2)

配送方式,1:直接领取;2:快递发货;3:线下核销

prize_num

int(11)

奖品总数量

get_task_num

int(11)

领取要求(对应活动奖品条件:目标人数、兑换条件、助力人数、签到天数等)

get_task_type

int(11)

日历抽奖玩法,任务类型,1:连续签到;2:累计签到

is_delete

int(2)

是否标记删除,若奖品已有领取则不支持删除


返回参数说明

返回JSON格式结果 Content-type: application/json

{"result":0,"msg":"","data":{"url":""}}

参与名称

类型

说明

result

int(2)

0表示成功,1表示失败

msg

string(100)

失败时,返回的错误描述

data

obj

详情见data参数说明


data参数说明

参与名称

类型

说明

url

string(100)

编辑活动地址

prize_list

obj

活动设置的奖品列表


prize_list参数说明

参与名称

类型

说明

grab_prize_list

obj

抽奖奖品列表,详见上面 grab_prize_list 参数说明

top_prize_list

obj

排行榜奖品列表,详见上面 top_prize_list 参数说明

get_prize_list

obj

领奖奖品列表,详见上面 get_prize_list 参数说明



注意事项

  • 签名错误,依据签名算法检查签名

  • 签名过期,需要重新生成签名

  • 未登录,表明登录状态过期,重新登录或调用免登录接口

  • 接口支持程度以实际活动设置页面为准

  • 注意:编辑集成必须使用和免登录集成同一个iframe容器,以便于保持登录状态一致代码示例 

  • 已经进行的活动,若奖品已有人中奖则无法删除和修改奖品类型

  • 修改奖品必须传奖品ID,奖品中不需修改值的则不用传入参数


代码示例


请求示例

{

    "app_key""96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"login_id ":"zhangsan_02",

"h5_guid""123456"

}


返回值示例, json格式 Content-type: application/json

{

    "result"0,

    "data"{

         "url""https://portal.rrx.cn/p/edit?id=123456#/",

         "prize_list"{

            "grab_prize_list": [{

        "product_id"122,

        "title""奖品名称"

        "prize_code""code_1"

                }]

        },

   },

    "msg""ok"

}



相关文档