新建活動(dòng)
API
[POST] /activitys_signin
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
activity_name | String | 否 | 活動(dòng)名稱 |
background | String | 否 | 背景圖片鏈接 |
logo | String | 否 | 機(jī)構(gòu)logo鏈接 |
music | String | 是 | 背景音樂鏈接 |
permission | String | 是 | 限制參與的會(huì)議id |
collect_info | String | 是 | 收集的用戶信息休雌,用逗號(hào)隔開 |
agency_id | String | 是 | 機(jī)構(gòu)id |
close_time | String | 是 | 截止時(shí)間 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 活動(dòng)ID |
code值含義:
{
0:請(qǐng)求成功
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":"關(guān)閉時(shí)間"
}
Return:
{
"code": 0,
"msg": "創(chuàng)建成功",
"data": “1”
}
查詢活動(dòng)內(nèi)容
API
[GET] /activitys_signin/{id}
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 是 | 返回?cái)?shù)據(jù) |
Data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
activity_id | String | 否 | 活動(dòng)id |
activity_name | String | 否 | 活動(dòng)名稱 |
background | String | 否 | 背景圖片鏈接 |
logo | String | 否 | 機(jī)構(gòu)logo鏈接 |
music | String | 否 | 背景音樂鏈接 |
permission | String | 是 | 限制參與的會(huì)議id |
collect_info | String | 是 | 收集的用戶信息,用逗號(hào)隔開 |
close_time | String | 是 | 截止時(shí)間 |
code值含義:
{
0:請(qǐng)求成功
1:操作失敗
}
Sample
[GET] http://localhost:9999/activitys_signin/1?access_token=xxx&access_type=org
Return:
{
"code": 0,
"msg": “查詢成功",
"data": {
略
}
}
更新活動(dòng)內(nèi)容
API
[PUT] /activitys_signin/{id}
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
activity_name | String | 是 | 活動(dòng)名稱 |
background | String | 是 | 背景圖片鏈接 |
logo | String | 是 | 機(jī)構(gòu)logo鏈接 |
music | String | 是 | 背景音樂鏈接 |
permission | String | 是 | 限制參與的會(huì)議id |
collect_info | String | 是 | 收集的用戶信息,用逗號(hào)隔開 |
close_time | String | 是 | 截止時(shí)間 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
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”
}
刪除活動(dòng)
API
[DELETE] /activitys_signin/{id}
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | activity ID |
Sample
[DELETE] http://localhost:9999/activitys_signin/{id}?access_token=xxx&access_type=org
Return:
{
"code": 0,
"msg": “刪除活動(dòng)成功”,
"data”:1
}
獲取機(jī)構(gòu)所有活動(dòng)列表
API
[GET] /activitys_signin
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
agency_id | String | 否 | 機(jī)構(gòu)ID |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Array | 否 | 活動(dòng)列表 |
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
activity_id | String | 否 | 活動(dòng)id |
activity_name | String | 否 | 活動(dòng)名稱 |
background | String | 否 | 背景圖片鏈接 |
logo | String | 否 | 機(jī)構(gòu)logo鏈接 |
join_count | String | 否 | 參與人數(shù) |
Data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
activity_id | String | 否 | 活動(dòng)id |
activity_name | String | 否 | 活動(dòng)名稱 |
background | String | 否 | 背景圖片鏈接 |
logo | String | 否 | 機(jī)構(gòu)logo鏈接 |
join_count | String | 否 | 參與人數(shù) |
Sample
[GET] http://localhost:9999/activitys_signin?access_token=xxx&access_type=org&agency_id=1
Return:
{
"code": 0,
"msg": “獲取活動(dòng)列表成功",
"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
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 是 | 留言消息 |
Data 數(shù)據(jù)項(xiàng):
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
message_id | String | 否 | 消息ID |
message_content | String | 否 | 消息內(nèi)容 |
member_id | String | 否 | 成員ID |
activity_id | String | 否 | 活動(dòng)ID |
message_type | String | 否 | 消息類型 |
message_status | String | 否 | 消息狀態(tài) |
message_create_time | int | 否 | 消息創(chuàng)建時(shí)間 |
message_status含義:
allow:未屏蔽狀態(tài)(等待審核)
ban:屏蔽狀態(tài)
finish:完成發(fā)送
Sample
[GET] http://localhost:9999/activitys_signin/1/message_list?access_token=xxx&access_type=org
Return:
{
"code": 0,
"msg": “獲取留言消息成功",
"data": []
}
分頁(yè)獲取留言消息
API
[GET] /activitys_signin/{id}/message_list_partition
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
page_size | String | 否 | 一頁(yè)顯示行數(shù) |
page_index | String | 否 | 頁(yè)索引 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 是 | 留言消息 |
Data 數(shù)據(jù)項(xiàng):
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
message_id | String | 否 | 消息ID |
message_content | String | 否 | 消息內(nèi)容 |
member_id | String | 否 | 成員ID |
activity_id | String | 否 | 活動(dòng)ID |
message_type | String | 否 | 消息類型 |
message_status | String | 否 | 消息狀態(tài) |
message_create_time | int | 否 | 消息創(chuàng)建時(shí)間 |
message_status含義:
allow:未屏蔽狀態(tài)(等待審核)
ban:屏蔽狀態(tài)
finish:完成發(fā)送
Sample
Return:
{
"code": 0,
"msg": “讀取成功",
"data": []
}
獲取簽到成員名單
API
[GET] /activitys_signin/{id}/signin_member_list
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 是 | 簽到成員名單 |
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 成員ID |
member_nickname | String | 否 | 用戶昵稱 |
member_icon | String | 否 | 用戶頭像 |
member_create_time | String | 否 | 創(chuàng)建時(shí)間 |
Data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 成員ID |
member_nickname | String | 否 | 用戶昵稱 |
member_icon | String | 否 | 用戶頭像 |
member_create_time | String | 否 | 創(chuàng)建時(shí)間 |
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"
}
]
分頁(yè)獲取簽到成員名單
API
[GET] /activitys_signin/{id}/signin_member_list_partition
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
page_size | String | 否 | 一頁(yè)顯示行數(shù) |
page_index | String | 否 | 頁(yè)索引 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 是 | 簽到成員名單 |
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 成員ID |
member_nickname | String | 否 | 用戶昵稱 |
member_icon | String | 否 | 用戶頭像 |
member_create_time | String | 否 | 創(chuàng)建時(shí)間 |
Data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 成員ID |
member_nickname | String | 否 | 用戶昵稱 |
member_icon | String | 否 | 用戶頭像 |
member_create_time | String | 否 | 創(chuàng)建時(shí)間 |
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"
}
]
導(dǎo)出簽到成員名單
API
[GET]
/activitys_signin/{id}/signin_member_list_export
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回
excel表signinlist.xlsx
禁言
API
[PUT] /activitys_signin/{id}/member/{member_id}/ban_message
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 是 | 活動(dòng)ID,成員ID |
解除禁言
API
[PUT] /activitys_signin/{id}/member/{member_id}/allow_message
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 是 | 活動(dòng)ID,成員ID |
查詢授權(quán)會(huì)議(提供給微信公眾號(hào)后臺(tái))
API
[GET] /activitys_signin/{id}/wx/auth_meeting
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 0 或 meeting_id, 0表示沒有會(huì)議授權(quán) |
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
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
member_icon | String | 否 | 頭像url |
member_nickname | String | 否 | 昵稱 |
member_id | String | 否 | 活動(dòng)成員id |
member_real_name | String | 是 | 活動(dòng)成員姓名 |
member_phone | String | 是 | 活動(dòng)成員手機(jī)號(hào)碼 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
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"
}
管理后臺(tái)注冊(cè)活動(dòng)socket
客戶端->服務(wù)端
ACTION :
bs_register_activity
參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值org |
id | String | 否 | 活動(dòng)ID |
微信端發(fā)送留言消息
客戶端->服務(wù)端
ACTION :
sign_message
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值user |
send_time | String | 否 | 發(fā)送時(shí)間 |
activity_id | String | 否 | 活動(dòng)ID |
member_id | String | 否 | 成員ID |
message_content | String | 否 | 消息內(nèi)容 |
推送留言消息狀態(tài)到留言頁(yè)面
服務(wù)端->客戶端
ACTION :
message_update
參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 否 | 消息對(duì)象 |
data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
send_time | String | 否 | 發(fā)送時(shí)間 |
message_status | String | 否 | 消息狀態(tài)渣锦,'allow' 帆赢、 'finish' 套硼、 'ban' 分別對(duì)應(yīng) =>正在發(fā)送 卡儒、完成發(fā)送 耐版、 被屏蔽 |
example Data:
{
"send_time"xxx
"message_status": "allow"
}
推送留言消息到管理后臺(tái)
服務(wù)端->客戶端
ACTION :
message
參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 否 | 消息對(duì)象 |
data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
send_time | String | 否 | 發(fā)送時(shí)間 |
activity_id | String | 否 | 活動(dòng)ID |
member_id | String | 否 | 成員ID |
member_icon | String | 否 | 頭像鏈接 |
member_nickname | String | 否 | 昵稱 |
message_id | String | 否 | 消息ID |
message_content | String | 否 | 消息內(nèi)容 |
message_status | String | 否 | 消息狀態(tài)寺庄,'allow' 艾蓝、 'finish' 、 'ban' 分別對(duì)應(yīng) =>正在發(fā)送 斗塘、完成發(fā)送 赢织、 被屏蔽 |
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"
}
推送留言消息狀態(tài)更新到管理后臺(tái)
服務(wù)端->客戶端
ACTION :
message_update
參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 否 | 消息對(duì)象 |
data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
message_id | String | 否 | 消息id |
send_time | String | 否 | 發(fā)送時(shí)間 |
message_status | String | 否 | 消息狀態(tài), 'finish' 馍盟、 'ban' 分別對(duì)應(yīng) =>完成發(fā)送 于置、 被屏蔽 |
example Data:
{
"message_id":'xxx',
"send_time"xxx,
"message_status": "finish"
}
獲取用戶的歷史留言消息
API
[GET] /activitys_signin/{id}/wx/member/{member_id}/message
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值user |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 否 | 歷史留言信息 |
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 簽到成員ID |
member_icon | String | 否 | 成員頭像 |
member_nickname | String | 否 | 成員昵稱 |
member_message | String | 否 | 留言消息 |
member_status | String | 否 | 成員狀態(tài) |
Data 數(shù)據(jù)項(xiàng):
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 簽到成員ID |
member_icon | String | 否 | 成員頭像 |
member_nickname | String | 否 | 成員昵稱 |
member_message | String | 否 | 留言消息 |
member_status | String | 否 | 成員狀態(tài) |
member_status含義:
allow:未屏蔽狀態(tài)
ban:屏蔽狀態(tài)
finish:完成發(fā)送
【提供給活動(dòng)頁(yè)面的接口】
活動(dòng)頁(yè)面注冊(cè)活動(dòng)
客戶端->服務(wù)端
ACTION :
register
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值org |
activity_id | String | 否 | 活動(dòng)ID |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 否 | 活動(dòng)id |
添加簽到成員到大屏活動(dòng)頁(yè)
服務(wù)端->客戶端
ACTION
join
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值org |
member_id | String | 否 | 成員ID |
member_icon | String | 否 | 頭像鏈接 |
member_nickname | String | 否 | 昵稱 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 否 | 成員ID |
添加留言到大屏活動(dòng)頁(yè)
服務(wù)端->客戶端
ACTION
message
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值org |
member_id | String | 否 | 成員ID |
member_icon | String | 否 | 頭像鏈接 |
member_nickname | String | 否 | 昵稱 |
member_message | String | 否 | 留言消息 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 否 | 成員ID |
獲取活動(dòng)頁(yè)面信息(本接口暫不實(shí)現(xiàn),若有需要再實(shí)現(xiàn))
API
[GET] /activitys_signin/{id}/page
請(qǐng)求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型,此處傳值user |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | JSON | 否 | 活動(dòng)內(nèi)容信息 |