帮助中心  /  活动参与人数据接口

活动参与人数据接口

该接口用于获取活动参与人的数据接口


接口请求说明

当前接口为v2版本,v1版本点击此处

请求地址

https://open.rrx.cn/api/v2/activity/GetActivityJoin

请求方式

GET

参数名称

是否必须

说明

app_key

人人秀平台分配的AppKey

time_stamp

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

sign

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

activity_guid

活动guid如何获取互动ID

h5_guid

H5活动guid

page

分页页码

limit

每页返回数量,不填默认20条,最大支持100/


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

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

参数名称

说明

result

0表示成功,1表示失败

msg

失败是,返回的错误描述

data

详情见data参数说明

 

接口返回参数说明

data参数说明

参数名称

是否必须

数据类型

说明

rows

object

参与人列表,详情见rows参数说明

activity_info

object

活动信息,详情见activity_info参数说明

total

int(32)

参与人总数

 

activity_info 参数说明

参数说明

是否必须

数据类型

说明

activity_name

string(20)

互动名称

activity_category

string(20)

互动类型,例如拼团、砍价

user_name

string(20)

活动创建人

is_deleted

tinyint(2)

互动是否删除

 

rows参数说明

通用参数

参数名称

是否必须

数据类型

说明

openid

string(128)

参与人唯一标识

nickname

string(60)

参与人显示昵称

headimgurl

string(200)

参与人显示头像地址

create_time

datetime

参与时间

source_name

string(60)

推广来源,活动从推广渠道链接访问时有值

employee_code

string(60)

员工工号,在设置/应用客户自定义字段启用时有值

user_info

object

报名信息,活动开启完善信息参与后有值

 

user_info 参数说明

参数说明

是否必须

数据类型

说明

id

int(11)

数据ID

title

string(100)

数据标题

value

string(200)

数据内容

 

答题类参数说明

支持答题、每日一答、闯关答题、考试、视频答题、猜灯谜

参数说明

是否必须

数据类型

说明

join_count

int(11)

答题次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

total_score

int(11)

答题分数

error_count

int(11)

答题错题数

right_rate

string(100)

答题正确率(%)

last_join_time

datetime

最后答题参与时间

 

支持趣味答题 

参数说明

是否必须

数据类型

说明

join_count

int(11)

答题次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

total_score

int(11)

答题分数

last_join_time

datetime

最后答题参与时间

 

 

支持学习答题

参数说明

是否必须

数据类型

说明

study_count

int(11)

学习次数

study_time

int(11)

学习时长(秒)

join_count

int(11)

答题次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

total_score

int(11)

答题分数

error_count

int(11)

答题错题数

right_rate

string(100)

答题正确率,x%

last_join_time

datetime

最后答题时间

last_study_time

datetime

最后学习时间

 

抽奖类参数说明

支持抽奖、红包、留言抽奖、扫描领奖、定时抽奖、VR抽奖、日历抽奖、口令抽奖、小票抽奖

参数说明

是否必须

数据类型

说明

join_count

int(11)

抽奖次数(留言次数、签到次数)

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间


支持签到抽奖

参数说明

是否必须

数据类型

说明

join_count

int(11)

签到次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

connect_count

int(11)

连续签到次数

gold_amount

int(11)

j金币数

last_join_time

datetime

最后参与时间


支持语音红包、口令红包

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

win_prize_count

int(11)

中奖次数



游戏类参数说明

支持游戏、闯关游戏、养成游戏

参数说明

是否必须

数据类型

说明

total_score

int(11)

参与人游戏分数(其他排行指标,金币数等)

join_count

int(11)

参与次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

问卷类参数说明

支持问卷调查、报名表单、投票评选、360测评

参数说明

是否必须

数据类型

说明

join_count

int(11)

抽奖次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

活动类参数说明

支持投票、图片合成、图片生成器

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

支持每日打卡

参数说明

是否必须

数据类型

说明

join_count

int(11)

累计签到次数

continue_count

int(11)

连续签到次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

支持活码

参数说明

是否必须

数据类型

说明

join_count

int(11)

累计签到次数

last_join_time

datetime

最后参与时间


支持活动报名

参数说明

是否必须

数据类型

说明

order_no

string

订单编号

pay_amount

float(2)

价格 

state_name

string(10)

状态 

order_type

string(10)

票种 

 

支持有奖竞猜

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

guesss_gold

int(11)

参与人金币数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

支持年度账单

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

last_join_time

datetime

最后参与时间

 

支持打赏

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

pay_amount

float(2)

打赏金额(2位小数)

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

 

节日类参数说明

支持漂流瓶、许愿树、孔明灯、新年Flag、新年签、节日头像、代言海报

参数说明

是否必须

数据类型

说明

join_count

int(11)

抽奖次数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

支持贺卡

参数说明

是否必须

数据类型

说明

join_count

int(11)

参与次数

invite_count

int(11)

邀请人数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

last_join_time

datetime

最后参与时间

 

 

裂变类参数说明

支持任务宝、限时有礼

参数说明

是否必须

数据类型

说明

invite_target_name

string(100)

任务奖品名称

invite_target

int(11)

任务目标人数

invite_count

int(11)

邀请人数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

 

支持集字助力

参数说明

是否必须

数据类型

说明

collect_total

int(11)

集字总数

collect_count

int(11)

集字套数

receive_prize_count

int(11)

领奖次数

 

支持拆礼盒

参数说明

是否必须

数据类型

说明

invite_target_name

string(100)

任务奖品名称

invite_target

int(11)

任务目标人数

invite_count

int(11)

邀请人数

receive_prize_count

int(11)

领奖次数

 

支持一元解锁

参数说明

是否必须

数据类型

说明

pay_amount

float(2)

购买金额(2位小数)

pay_count

int(11)

购买次数

invite_count

int(11)

邀请人数

 

 

支持裂变海报

参数说明

是否必须

数据类型

说明

invite_count

int(11)

邀请人数

win_prize_count

int(11)

中奖次数

receive_prize_count

int(11)

领奖次数

 

 

电商类参数说明

支持砍价

参数说明

是否必须

数据类型

说明

progress

string(60)

砍价进度(%)

remain_price

float(2)

剩余砍价金额

pay_amount

float (2)

已支付金额

remain_amount

float(2)

剩余支付金额

state_name

string(10)

订单状态

receive_time

datetime

兑换时间

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情


支持助力

参数说明

是否必须

数据类型

说明

hlep_count

int(11)

助力人数

remain_price

float(2)

助力金额

pay_amount

float (2)

已支付金额

remain_amount

float(2)

剩余支付金额

state_name

string(10)

订单状态

receive_time

datetime

兑换时间

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 

支付分销

参数说明

是否必须

数据类型

说明

commission_amount

float (2)

一级佣金

commission_openid

string(128)

一级佣金用户标识

second_commission_amount

float (2)

二级佣金

second_commission_openid

string (128)

二级佣金用户标识

product_id

int (11)

商品id

product_name

string (20)

商品名称

product_num

int (11)

购买商品数量

pay_amount

float (2)

已支付金额

commission_state

tyint (2)

佣金是否已入账  0:未入账;1:已入账 

订单完成状态才会入账。(比如配送订单,确认收货后到账)

withdrawal_state

tyint (2)

一级佣金是否已提现  0:未提现;1:已提现 

second_withdrawal_state

tyint (2)

二级佣金是否已提现  0:未提现;1:已提现 

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 

支持拼团

参数说明

是否必须

数据类型

说明

sart_group_time

datetime

开团时间

pay_amount

float(2)

已支付金额

group_price

float (2)

成团价格

is_captain

int(1)

是否团长

pay_type

string(10)

付款方式

group_rule_type

string(10)

成团类型

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 

支持万人团

参数说明

是否必须

数据类型

说明

sart_group_time

datetime

开团时间

pay_amount

float(2)

已支付金额

is_captain

int(1)

是否团长

state_name

string(10)

订单状态

group_type_name

string(10)

成团阶段

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 

支持秒杀

参数说明

是否必须

数据类型

说明

seckill_price

float(2)

秒杀价格

pay_amount

float(2)

已支付金额

state_name

string(10)

订单状态

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 

支持优惠券

参数说明

是否必须

数据类型

说明

prize_name

string(60)

优惠券名称

prize_detail

string(200)

优惠券详情

order_no

string(32)

对应人人秀订单号。领取后产生订单记录,可通过订单记录接口获取订单详情

 


活动支持说明

  • 1.适用于活动类活动,活动参与人,支持投票、图片合成、图片生成器、打赏、活动报名、有奖竞猜;

  • 2.适用于答题类活动,活动参与人,支持答题、每日一答、趣味答题、猜灯谜、视频答题、PK答题、考试;

  • 3.使用于游戏类活动,活动参与人,支持游戏、闯关游戏、养成游戏;

  • 4.适用于裂变类活动,活动参与人裂变统计,支持拆礼盒、集字助力、任务宝、限时有礼、裂变海报;

  • 5.适用于电商类活动,活动参与人订单记录,支持砍价、助力、分销、拼团、万人团、秒杀、优惠券;

  • 6.适用于节日类活动,活动参与人,支持许愿树、孔明灯、心愿池、新年签、代言海报、节日头像、新年Flag;

  • 7.使用于红包类互动,活动参与人,支持语音红包、口令红包;

  • 8.适用于抽奖类活动,活动参与人,抽奖、签到抽奖、留言抽奖、扫码抽奖、定时抽奖、VR抽奖、日历抽奖、口令抽奖、小票抽奖、红包。抽奖类可通过【活动中奖记录接口】获取更多中奖记录数据

 

代码示意

请求示例

{

    "app_key""96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"activity_guid""f2f219309b5c1a021fc019b3b557b9f8",

"h5_guid":"123456",

"page ":1,

"limit ":20

}

 

 

 

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

{

    "result"0,

    "data": {

         "total"10,

"activity_info"{

"activity_name""抽奖名称",

"activity_category""抽奖",

"user_name""张三",

"is_deleted"0,

},

"rows"[{

"openid "" gb_1543999047492",

"nickname""小张子",

"headimgurl""https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TMaE…zXTfZQugNBA/132",

     "create_time""2099-09-10 09:10:00",

"source_name""百度",

"employee_code""",

"user_info"[

          "id""100","title""姓名","value""张三"},

          {"id""300","title""手机号","value""15811111111"},

],


}]

    },

    "msg""ok"

}


相关文档