说明
获取当前在线用户的列表信息。
在您使用任何本文档所描述的HTTP API之前,您必须先获得使用HTTP API的授权。
语音对讲服务器授权的机制简单描述如下:
1) 在Request Headers的Cookie里添加,例如:
time=undefined; username=admin; user=admin; alias=admin; token=ZIK48H80V32Y17R0IBZA8F4P3AGCGF2F;
需要带上username和user,token信息
授权本身也是一个HTTP API,不过它与其它的API不同之处在于, Authorization Token是授权,而是通过检查您提交的用户名和密码来为Authorization Token。
API URL
/intercom/user/onlinelist.json
Request
Method:GET/POST
Response
格式(Example):
{
"result":"ok",
"data":{
"users":[
{
"alias":"admin",
"mute":1,
"audioGain":200,
"descript":"",
"offmicro":1,
"position":[0],
"username":"admin",
"type":"user"
},
{
"alias":"hhy",
"mute":0,
"audioGain":200,
"descript":"hhy",
"offmicro":1,
"position":[0],
"username":"hyl",
"type":"user"
}
]
}
}
Data字段说明:
Field | Value | 说明 |
---|---|---|
role_id | [STRING] | 用户角色。 |
mute | [INT] | 1-静音 0-不静音。现在没用,忽略 |
username | [STRING] | 用户名 |
audioGain | [INT] | 音量大小,范围:0~200 |
descript | [STRING] | 描述 |
offmicro | [INT] | 是否关麦,1-关麦,0-开麦 |
position | [ARRAY] | 当前在哪个组 |
type | [STRING] | 类型:user是用户登录,device是设备登录 |
一些建议:
1) 提醒您注意!position和mute暂时没用,可以忽略。