Skip to content

Latest commit

 

History

History
131 lines (91 loc) · 3.84 KB

README.md

File metadata and controls

131 lines (91 loc) · 3.84 KB

BandoriStation

The room number collection platform of Bang Dream! Girls Band Party!

邦邦车牌/房间收集平台

目前已接入的QQ群机器人:

API说明

API地址,支持HTTP和HTTPS协议

api.bandoristation.com/

API支持GET和POST两种请求方式,返回数据为JSON格式

使用GET请求时参数通过URL参数传入

https://api.bandoristation.com/?function=query_room_number

使用POST请求时参数通过JSON传入

{"function":"query_room_number"}

查询房间数据

HTTP/HTTPS

参数

字段名 数据类型 填入值 说明
function string query_room_number
latest_time number 13位时间戳 选填参数,填入之后将不返回该时间之前的数据

响应数据

字段名 数据类型 说明
status string success/failure
response array/string status为success时返回数据array,为failure时返回原因

房间数据

房间数据为字段response类型为array时的单条数据

字段名 数据类型 说明
number string 房间号
raw_message string 房间的说明文字/原始信息
source_info object 数据来源信息
type string 房间类型
time number 房间的发布时间,13位时间戳
user_info object 用户信息

source_info:

字段名 数据类型 说明
name string 数据源名称
type string 数据源类型

user_info:

字段名 数据类型 说明
type string 用户类型
user_id number 用户ID
username string 用户名
avatar string 用户头像

WebSocket

请求地址 wss://api.bandoristation.com:50443 ,本接口将会定时返回房间数据,数据格式与HTTP/HTTPS接口的返回数据相同。WebSocket需要客户端发送心跳包维持连接,心跳包内容可以是heartbeat或者其他任意数据,心跳包发送间隔为30秒

提交房间数据

目前仅提供HTTP/HTTPS接口,接口仅对其他邦邦房间数据平台(机器人或者网站)开放,不对个人开放。想要接入可以联系QQ 2287477889,如果加不了好友也可以发送邮件给[email protected],我会主动联系你。接入者请保持数据提交活跃度和质量,不合格者可能会被撤销

参数

字段名 数据类型 填入值 说明
function string submit_room_number
number string 房间号 5-6位整数
user_id number 用户的唯一识别码 QQ号或者其他ID
raw_message string 房间的说明文字/原始信息 如果使用GET方式传入需要URL编码
source string 房间数据来源 机器人或者平台名称,如果是中文或者其他非英文、数字的字符并且使用GET方式传入需要URL编码
token string 口令
type string 25/18/12/7/other 选填参数,房间类型

响应数据

字段名 数据类型 说明
status string success/failure
response string status为success时返回空字符串,为failure时返回原因

获取在线人数

获取停留在主页的人数

参数

字段名 数据类型 填入值 说明
function string get_online_number

响应数据

字段名 数据类型 说明
status string success/failure
response object/string status为success时返回object,为failure时返回原因

response:

字段名 数据类型 说明
online_number number 在线人数