通过API开发者可实时获取在线用户数。 在线用户数指所有登录软终端的用户数量总和。
默认接口请求频率限制：20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/enterprise/data/onlineCount?enterpriseId=XXX&depCode=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9无此接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | 5.2 (2024-0329版本） |
signature | String | Query | 签名鉴权1.0（旧）：是 签名鉴权2.0：否 | 无 | API签名，参见签名规则 | 5.2 (2024-0329版本） |
depCode | String | Query | 否 | 无 | 查询条件，部门编码 | 5.2 (2024-0329版本） |
返回结果示例：
{
"totalCount": xxx,
"idleCount": xxx,
"offlineCount": xxx,
"incallCount": xxx,
}返回参数说明
参数 | 说明 |
totalCount | 用户总数量 |
idleCount | 用户空闲数量 |
offlineCount | 用户离线数量 |
incallCount | 用户通话中数量 |
注：
1.用户总数量=用户空闲数量+用户通话中数量+用户离线数量
2.用户在线数量=用户空闲数量+用户通话中数量