提交工单
咨询集成、功能及报价等问题
http请求方式: POST/JSON,需使用https
服务环境 | 调用频率限制 | 请求示例 |
---|---|---|
国内正式环境 | 10次/秒 | curl -X POST https://liveroom{APPID}-api.zego.im/cgi/usercount -d 'json_str' |
海外正式环境 | 10次/秒 | curl -X POST https://liveroom{APPID}-api.zegocloud.com/cgi/usercount -d 'json_str' |
国内测试环境 | 1次/秒 | curl -X POST https://test2-liveroom-api.zego.im/cgi/usercount -d 'json_str' |
海外测试环境 | 1次/秒 |
|
json_str 内容如下:
{
"access_token": "ACCESS_TOKEN",
"version": 1,
"seq": 1,
"room_ids": ["r1", "r2", "r3"]
}
参数名 | 类型 | 是否必须 | 说明 |
---|---|---|---|
access_token | String | 是 | 调用接口凭证 |
version | Int | 是 | 协议版本号,默认填1 |
seq | Int | 是 | 协议序列号 |
room_ids | Array | 是 | 房间 ID数组,一次调用最大支持10个房间 |
正常情况下,会返回下述JSON数据包给调用方:
{
code : 0,
message : 'success',
data:{
"version": 1,
"seq": 7,
"count_array": [
{
"room_id": "r1",
"user_count": 10
}
]
}
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
code | Int | 返回码 |
message | String | 操作结果描述 |
version | Int | 协议版本号 |
seq | Int | 协议序列号 |
count_array | Array | 房间用户数组,一次调用最大支持10个房间 |
room_id | String | 房间 ID |
user_count | Int | 房间用户数 |
错误时会返回错误码等信息,JSON数据包示例如下(该示例为输入参数错误):
{
"code": 2,
"message": "输入参数错误"
}
联系我们
文档反馈