新建活动
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
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
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 | 否 | 活动内容信息 |