第三方可以使用此接口查询企业下终端总数,终端空闲数,终端离线数,终端通话中数量。同时支持按终端类型作为参数查询。
默认接口请求频率限制:20 次/秒
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/enterprise/device/onlineCount?enterpriseId=XXX&signature=XXX&deviceCategory=xxx
请求参数说明:
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | 传v1即可 | 3.9无此接口 5.2无此接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参考 签名鉴权 | |
deviceCategory | String | Query | 否 | 无 | 设备型号 (NE60, NE90等小鱼终端设备型号) | 6.0 |
depCode | String | Query | 否 | 无 | 部门编码(不包含本部门下子部门的数据) |
请求成功返回结果示例
{
"totalCount":xxx,
"idleCount": xxx,
"offlineCount": xxx,
"incallCount":xxx,
}
返回参数说明:
参数 | 说明 |
totalCount | 企业终端总数量 |
idleCount | 企业终端空闲数量 |
offlineCount | 企业终端离线数量 |
incallCount | 企业终端通话中数量 |
错误码见小鱼RESTAPI错误码