签到墙互动项目API

新建活动

API

[POST] /activitys_signin

请求参数

参数 类型 允许为空 描述
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
permission String 限制参与的会议id
collect_info String 收集的用户信息,用逗号隔开
agency_id String 机构id
close_time String 截止时间

返回参数

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

code值含义:

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

Sample

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

Body:

{
  "activity_name": "签到",
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo":"",
  "music": "",
  "permission": "",
  "collect_info":"phone,name",
  "barcode": "链接",
  "agency_id": "非空",
  "close_time":"关闭时间"
}

Return:

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

查询活动内容

API

[GET] /activitys_signin/{id}

请求参数

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

返回参数

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

Data:

参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
permission String 限制参与的会议id
collect_info String 收集的用户信息,用逗号隔开
close_time String 截止时间

code值含义:

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

Sample

[GET] http://localhost:9999/activitys_signin/1?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “查询成功",
  "data": {
          略
     }
}

更新活动内容

API

[PUT] /activitys_signin/{id}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
permission String 限制参与的会议id
collect_info String 收集的用户信息,用逗号隔开
close_time String 截止时间

返回参数

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

Sample

[PUT] http://localhost:9999/activitys_signin/1?access_token=xxx&access_type=org

Body:

{
  "activity_name": “签到墙1”,
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo": “”,
  “music”: "",
  “permission: "",
  "collect_info":"name,phone"
}

Return:

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

删除活动

API

[DELETE] /activitys_signin/{id}

请求参数

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

返回参数

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

Sample

[DELETE] http://localhost:9999/activitys_signin/{id}?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “删除活动成功”,
  "data”:1
}

获取机构所有活动列表

API

[GET] /activitys_signin

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
agency_id String 机构ID

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Array 活动列表
参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
join_count String 参与人数

Data:

参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
join_count String 参与人数

Sample

[GET] http://localhost:9999/activitys_signin?access_token=xxx&access_type=org&agency_id=1

Return:

{
  "code": 0,
  "msg": “获取活动列表成功",
  "data": [
        {
          "id":1,
          "activity_name":"lottery1",
          "background":"xxxx",
          "logo":"xxxx",
          "join_count": 10
       },      
        {
          "id":2,
          "activity_name":"lottery2",
          "background":"xxxx",
          "logo":"xxxx",
          "join_count": 10
       },               
}

获取留言消息

API

[GET] /activitys_signin/{id}/message_list

请求参数

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

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 留言消息

Data 数据项:

参数 类型 允许为空 描述
message_id String 消息ID
message_content String 消息内容
member_id String 成员ID
activity_id String 活动ID
message_type String 消息类型
message_status String 消息状态
message_create_time int 消息创建时间

message_status含义:

allow:未屏蔽状态(等待审核)
ban:屏蔽状态
finish:完成发送

Sample

[GET] http://localhost:9999/activitys_signin/1/message_list?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “获取留言消息成功",
  "data": []
}

分页获取留言消息

API

[GET] /activitys_signin/{id}/message_list_partition

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 留言消息

Data 数据项:

参数 类型 允许为空 描述
message_id String 消息ID
message_content String 消息内容
member_id String 成员ID
activity_id String 活动ID
message_type String 消息类型
message_status String 消息状态
message_create_time int 消息创建时间

message_status含义:

allow:未屏蔽状态(等待审核)
ban:屏蔽状态
finish:完成发送

Sample

[GET] http://localhost:9999/activitys_signin/100/message_list_partition?access_token=xxx&access_type=org&page_size=10&page_index=1

Return:

{
  "code": 0,
  "msg": “读取成功",
  "data": []
}

获取签到成员名单

API

[GET] /activitys_signin/{id}/signin_member_list

请求参数

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

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 签到成员名单
参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 用户昵称
member_icon String 用户头像
member_create_time String 创建时间

Data:

参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 用户昵称
member_icon String 用户头像
member_create_time String 创建时间

Sample

[GET] http://localhost:9999/activitys_signin/1/signin_member_list?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “读取成功",
  "data": [
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       },      
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       }
]

分页获取签到成员名单

API

[GET] /activitys_signin/{id}/signin_member_list_partition

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 签到成员名单
参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 用户昵称
member_icon String 用户头像
member_create_time String 创建时间

Data:

参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 用户昵称
member_icon String 用户头像
member_create_time String 创建时间

Sample

[GET] http://localhost:9999/activitys_signin/1/signin_member_list_partition?access_token=xxx&access_type=org&page_size=10$page_index=1

Return:

{
  "code": 0,
  "msg": “读取成功",
  "data": [
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       },      
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       }
]

导出签到成员名单

API

[GET]
/activitys_signin/{id}/signin_member_list_export

请求参数

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

返回
excel表signinlist.xlsx

禁言

API

[PUT] /activitys_signin/{id}/member/{member_id}/ban_message

请求参数

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

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Object 活动ID,成员ID

解除禁言

API

[PUT] /activitys_signin/{id}/member/{member_id}/allow_message

请求参数

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

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Object 活动ID,成员ID

查询授权会议(提供给微信公众号后台)

API

[GET] /activitys_signin/{id}/wx/auth_meeting

请求参数

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

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 0 或 meeting_id, 0表示没有会议授权

Sample

[GET] http://localhost:9999/activitys_signin/1/wx/auth_meeting?access_token=xxx&access_type=user

Return:

{
  "code": 0,
  "msg": "成功获取",
  "data": 520
}

上传用户微信头像URL和昵称

API

[POST] /activitys_signin/{id}/wx/userInfo

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
member_icon String 头像url
member_nickname String 昵称
member_id String 活动成员id
member_real_name String 活动成员姓名
member_phone String 活动成员手机号码

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 成员id

Sample

[POST] http://localhost:9999/activitys_signin/1/wx/userInfo?access_token=xxx&access_type=org

Body:

{
  "member_icon": "xxx",
  "member_nickname": "abc”,
  "member_id": “xxxx”
}

Return:

{
  "code": 0,
  "msg": "提交用户微信信息成功",
  "data": "xxxx"
}

管理后台注册活动socket

客户端->服务端

ACTION :

bs_register_activity

参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值org
id String 活动ID

微信端发送留言消息

客户端->服务端

ACTION :

sign_message

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user
send_time String 发送时间
activity_id String 活动ID
member_id String 成员ID
message_content String 消息内容

推送留言消息状态到留言页面

服务端->客户端

ACTION :

message_update

参数

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

data:

参数 类型 允许为空 描述
send_time String 发送时间
message_status String 消息状态,'allow' 、 'finish' 、 'ban' 分别对应 =>正在发送 、完成发送 、 被屏蔽

example Data:

{
    "send_time"xxx
     "message_status": "allow"  
}

推送留言消息到管理后台

服务端->客户端

ACTION :

message

参数

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

data:

参数 类型 允许为空 描述
send_time String 发送时间
activity_id String 活动ID
member_id String 成员ID
member_icon String 头像链接
member_nickname String 昵称
message_id String 消息ID
message_content String 消息内容
message_status String 消息状态,'allow' 、 'finish' 、 'ban' 分别对应 =>正在发送 、完成发送 、 被屏蔽

example Data:

{
    "send_time"xxx
    "activity_id":xxx
     "member_id":xxx
     "message_id":xxxx
     "member_icon" : xxxx
     "member_nickname":xxx
     "message_content":xxxx
     "message_status": "allow"  
}

推送留言消息状态更新到管理后台

服务端->客户端

ACTION :

message_update

参数

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

data:

参数 类型 允许为空 描述
message_id String 消息id
send_time String 发送时间
message_status String 消息状态, 'finish' 、 'ban' 分别对应 =>完成发送 、 被屏蔽

example Data:

{
    "message_id":'xxx',
    "send_time"xxx,
     "message_status": "finish"  
}

获取用户的历史留言消息

API

[GET] /activitys_signin/{id}/wx/member/{member_id}/message

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 历史留言信息
参数 类型 允许为空 描述
member_id String 签到成员ID
member_icon String 成员头像
member_nickname String 成员昵称
member_message String 留言消息
member_status String 成员状态

Data 数据项:

参数 类型 允许为空 描述
member_id String 签到成员ID
member_icon String 成员头像
member_nickname String 成员昵称
member_message String 留言消息
member_status String 成员状态

member_status含义:

allow:未屏蔽状态
ban:屏蔽状态
finish:完成发送

【提供给活动页面的接口】

活动页面注册活动

客户端->服务端

ACTION :

register

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值org
activity_id String 活动ID

返回参数

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

添加签到成员到大屏活动页

服务端->客户端

ACTION

join

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值org
member_id String 成员ID
member_icon String 头像链接
member_nickname String 昵称

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 成员ID

添加留言到大屏活动页

服务端->客户端

ACTION

message

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值org
member_id String 成员ID
member_icon String 头像链接
member_nickname String 昵称
member_message String 留言消息

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 成员ID

获取活动页面信息(本接口暂不实现,若有需要再实现)

API

[GET] /activitys_signin/{id}/page

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 活动内容信息
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容

  • 【提供给机构管理后台接口】 新建活动 API [POST] /activitys_signin 请求参数 返回参数...
    kingsonCai阅读 366评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,633评论 18 139
  • 新建活动 API [POST] /activitys_message 请求参数 返回参数 code值含义: Sam...
    kingsonCai阅读 536评论 0 0
  • 抽奖活动API 获取参与抽奖名单 分页获取参与抽奖名单 导出参与名单的报表模板 导入参与名单 内定中奖名单列表 获...
    kingsonCai阅读 2,511评论 1 1
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,598评论 18 399