摇一摇互动API

摇一摇互动API

• 新建活动
• 查询活动内容
• 更新活动内容
• 删除活动
• 查询可否参与游戏
• 导出参与名单
• 读取游戏轮次
• 数据统计
• 查询得分排行榜
• 恢复游戏场景
• 恢复微信端游戏场景
• 活动页面注册活动-socket
• 添加参与成员到大屏活动页-socket
• 开始游戏-socket
• 通知游戏正式开始-socket
• 实时top_n数据-socket
• 游戏结束最终排名-socket
• 微信端注册用户-socket
• 通知微信端游戏开始-socket
• 微信端同步分数-socket
• 同步排名给微信端-socket
• 推给微信端最终得分-socket
• 再来一轮-socket

通用参数

• 状态码code的含义

{
  0：请求成功
  1：操作失败
}

• 所有的API请求都要携带token参数

{
  access_token:  访问token
  access_type:  token类型
}

service Root URL

正式环境：https://activity.tinstone-course.com/server/v1
测试环境：https://activity.bshapp.cn/server/v1

socket通讯URL

• url
  • 正式环境：https://activity.tinstone-course.com
  • 测试环境：https://activity.bshapp.cn
• path:socket.shake

新建活动

API

[POST] /activitys_shake

请求参数

参数	类型	允许为空	描述
background	String	否	背景图片链接
activity_name	String	否	活动标题
permission	String	是	限定的会议ID
agency_id	String	否	机构ID
shake_time	String	否	摇一摇时间
show_top_n	String	否	显示前n名
win_limit	String	否	前几名中奖
close_time	int	否	截止时间

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	活动ID

Sample

[POST] http://localhost:9999/activitys_shake?access_token=xxx&access_type=org

Body:

{
  "activity_name": "摇一摇互动",
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg",
  "permission": "",
  "shake_time": "",
  "show_top_n": "",
  "agency_id": "非空",
  "close_time":"关闭时间",
  ]
}

Return:

{
  "code": 0,
  "msg": "创建成功",
  "data": “1”
}

查询活动内容

API

[GET] /activitys_shake/{id}

请求参数

参数	类型	允许为空	描述
access_token	String	否	访问凭证
access_type	String	否	凭证类型

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	返回数据

Data:

参数	类型	允许为空	描述
id	int	否	活动ID
其它参数同 创建活动时提交的参数

更新活动内容

API

[PUT] /activitys_shake/{id}

请求参数

参数	类型	允许为空	描述
id	int	否	活动ID
其它参数同 创建活动时提交的参数

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	活动 ID

Return:

{
  "code": 0,
  "msg": "更新成功",
  "data": “1”
}

删除活动

API

[DELETE] /activitys_shake/{id}

请求参数

参数	类型	允许为空	描述
access_token	String	否	访问凭证
access_type	String	否	凭证类型

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	活动 ID

查询可否参与游戏

API

[GET] /activitys_shake/{id}/member/{member_id}/can_join

请求参数

参数	类型	允许为空	描述
access_token	String	否	访问凭证
access_type	String	否	凭证类型

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	能否参与

data:

'can':可以
‘can_not':不可以

导出参与名单

API

[GET] /activitys_shake/{id}/member_list_export/{round}

返回

excel表 memberlist-round-{round}.xlsx

读取游戏轮次

API

[GET] /activitys_shake/{id}/rounds

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Array	是	游戏轮次，空数组[]表示还未有用户参与

数据统计

API

[GET] /activitys_shake/{id}/statistics/{round}

请求参数

参数	类型	允许为空	描述
page_size	String	否	一页显示行数，默认为10
page_index	String	否	页索引，默认为1，若为0则不分页

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	统计数据

data对象格式:

参数	类型	允许为空	描述
total	int	否	总数
current_page	Array	否	当前页数据

current_page 数组数据项格式：

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像
member_game_rank	int	否	排名
member_game_score	int	否	分数
create_time	int	否	参与时间

查询得分排行榜

API

[GET] /activitys_shake/{id}/rank

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	返回数据

Data:

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像
member_game_rank	int	否	排名
member_game_score	int	否	分数

恢复游戏场景

API

[GET] /activitys_shake/{id}/game_scene

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	游戏当前场景数据

data格式:

参数	类型	允许为空	描述
game_status	String	否	游戏状态
member_list	Array	是	成员列表
top_n	Array	是	排名前n的数据
wininfo	Array	是	游戏结束后最终排名

game_status：

  wait:等待开始，
  begin:开始倒计时，
  gaming:游戏中，
  over:游戏结束

member_list数组数据项格式：

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像

top_n数组数据项格式：

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像
member_game_rank	int	否	排名
member_game_score	int	否	分数

wininfo数组数据项格式：

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像
member_game_rank	int	否	排名
member_game_score	int	否	分数

恢复微信端游戏场景

API

[GET] /activitys_shake/{id}/game_scene_wx/member/{member_id}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	游戏当前场景数据

data格式:

参数	类型	允许为空	描述
game_status	String	否	游戏状态
wininfo	Array	是	游戏结束后最终排名,只有游戏结束状态才需使用本字段

game_status：

  wait:等待开始，
  begin:开始倒计时，
  gaming:游戏中，
  over:游戏结束

wininfo数组数据项格式：

参数	类型	允许为空	描述
member_id	int	否	成员ID
member_nickname	String	否	成员昵称
member_icon	String	否	成员头像
member_game_rank	int	否	排名
member_game_score	int	否	分数
beat	int	否	打败对手百分比,如90表示90%

【提供给大屏互动端的接口】

活动页面注册活动-socket

客户端->服务端

ACTION ：

register

客户端向服务端推送参数

参数	类型	允许为空	描述
id	int	否	活动ID

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	否	活动id

添加参与成员到大屏活动页-socket

服务端->客户端

ACTION

join

服务端向客户端推送参数

参数	类型	允许为空	描述
member_id	String	否	成员ID
member_icon	String	否	头像链接
member_nickname	String	否	昵称

开始游戏-socket

客户端->服务端

ACTION

shake_begin

客户端向服务端推送参数

参数	类型	允许为空	描述
activity_id	int	否	活动ID

服务端返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	否	消息对象

data对象格式：

参数	类型	允许为空	描述
activity_id	int	否	活动ID

通知游戏正式开始-socket

服务端->客户端

ACTION

shake_has_begined

服务端向客户端推送参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	否	消息对象

data对象格式：

参数	类型	允许为空	描述
activity_id	int	否	活动ID

实时top_n数据-socket

服务端->客户端

ACTION

shake_top_n

服务端向客户端推送参数

参数	类型	允许为空	描述
data	Array	否	top_n数据
~~	update_data	Array	否	数据	~~

data数组数据项格式：

参数	类型	允许为空	描述
member_id	String	否	成员ID
member_icon	String	否	头像链接
member_nickname	String	否	昵称
member_game_rank	int	否	排名
member_game_score	int	否	分数

游戏结束最终排名-socket

服务端->客户端

ACTION

shake_over

服务端向客户端推送参数

参数	类型	允许为空	描述
member_id	String	否	成员ID
member_icon	String	否	头像链接
member_nickname	String	否	昵称
member_game_rank	int	否	排名
member_game_score	int	否	分数

【提供给微信端的接口】

微信端注册用户-socket

客户端->服务端

ACTION ：

register_member

客户端向服务端推送参数

参数	类型	允许为空	描述
member_id	String	否	用户ID

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	否	用户ID

通知微信端游戏开始-socket

服务端->客户端

ACTION

wx_shake_begin

服务端向客户端推送参数

参数	类型	允许为空	描述
activity_id	int	否	活动ID
round	int	否	轮次
time	String	否	倒计时

微信端同步分数-socket

客户端->服务端

ACTION

wx_shake_score

客户端向服务端推送参数

参数	类型	允许为空	描述
activity_id	int	否	活动ID
member_id	String	否	成员ID
member_game_score	int	否	分数

同步排名给微信端-socket

服务端->客户端

ACTION

wx_shake_rank

服务端向客户端推送参数

参数	类型	允许为空	描述
member_id	String	否	成员ID
member_icon	String	否	头像链接
member_nickname	String	否	昵称
member_game_rank	int	否	排名
member_game_score	int	否	分数

推给微信端最终得分-socket

服务端->客户端

ACTION

wx_shake_over

服务端向客户端推送参数

参数	类型	允许为空	描述
member_id	String	否	成员ID
member_icon	String	否	头像链接
member_nickname	String	否	昵称
member_game_rank	int	否	排名
member_game_score	int	否	分数
beat	int	否	打败对手百分比,如90表示90%

再来一轮-socket

客户端->服务端

ACTION

next_round

客户端向服务端推送参数

参数	类型	允许为空	描述
activity_id	int	否	活动ID