第三方可以调用该接口分页获取本企业下所有的小鱼硬终端设备信息
默认接口请求频率限制：20次/秒
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/enterprise/device/info/page?enterpriseId=XXX&category=XXX&depCode=xxx&callState=xxx&pageIndex=XXX&pageSize=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 5.2-20230922 公有云 |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | 5.2-20230922 公有云 |
category | String | Query | 否 | 无 | 设备型号(例: NE60, AE350, 值为xylink查询所有小鱼终端，值为H323查询所有323终端，不传查询所有终端) | 5.2-20230922 公有云 |
depCode | String | Query | 否 | 无 | 部门编码（不传查询企业下所有，传0查询根部门下设备） | 5.2-20230922 公有云 |
callState | String | Query | 否 | 无 | 设备呼叫状态（offline离线，idle空闲，incall呼叫中） | 5.2-20230922 公有云 |
pageIndex | int | Query | 否 | 0 | 页码 | 5.2-20230922 公有云 |
pageSize | int | Query | 否 | 20 | 查询数量（最大100） | 5.2-20230922 公有云 |
{
"page": 0,
"pageTotal": 1,
"rowsTotal": 16,
"rows": 100,
"list": [
{
"name": "智能视频终端",
"number": "xxxxxx",
"callState": "xxxxxx",
"sn": "xxxxxx",
"firstBindTime": "xxxxxx",
"portExpireTime": "xxxxxx",
"extendTime": "xxxxxx",
"clientVersion": xxxxxx,
"category": "xxxxxx",
"departName": [
"xxxxxx"
],
"depCodes": [
"xxxxxx"
],
"internalIp": "xxxxxx",
"externalIp": "xxxxxx",
"allowNemoNumberCall": 1,
"allowOutgoingCall": 1,
"autoAnswer": 0,
"showRecordingIndicator": true,
"noDisturbIncall": false,
"enableFecc": true,
"isOnline": false
}
]
}返回参数说明
参数名称 | 说明 | |
page | 当前页（pageIndex） | 5.2-20230922 公有云 |
pageTotal | 总页数 | 5.2-20230922 公有云 |
rowsTotal | 数据总条数 | 5.2-20230922 公有云 |
rows | 每页面显示条数（pageSize） | 5.2-20230922 公有云 |
list | 终端设备列表 | 5.2-20230922 公有云 |
name | 设备名称 | 5.2-20230922 公有云 |
number | 设备号 | 5.2-20230922 公有云 |
callState | 设备在呼叫状态( incall呼叫中，idle空闲，offline离线或者未上报) | 5.2-20230922 公有云 |
sn | 设备sn | 5.2-20230922 公有云 |
fitstBindtime | 设备开机时间 | 5.2-20230922 公有云 |
portExpireTime | 设备端口号到期时间 | 5.2-20230922 公有云 |
extendTime | 设备延保到期时间 | 5.2-20230922 公有云 |
clientVersion | 系统版本(如设备未正常注册，本字段会返回null，请尝试重新进行注册) | 5.2-20230922 公有云 |
category | 设备型号 | 5.2-20230922 公有云 |
departName | 设备所属部门 | 5.2-20230922 公有云 |
depCodes | 设备所属部门编码 | 5.2-20230922 公有云 |
internalIp | 内部ip | 5.2-20230922 公有云 |
externalIp | 外部ip | 5.2-20230922 公有云 |
isOnline | 设备是否在线 | 5.2-20230922 公有云 |
allowNemoNumberCall | 被呼叫范围。0：关闭，1：所有用户，2：通讯录用户，3：非匿名用户 | 5.2-20251226 公有云不存在 |
allowOutgoingCall | 允许主动呼叫范围。0：关闭，1：所有用户，2：通讯录用户 | 5.2-20251226 公有云不存在 |
autoAnswer | 自动应答。0：关闭，1：所有用户，2：通讯录用户 | 5.2-20251226 公有云不存在 |
showRecordingIndicator | 是否显示录制提示。false:否，true:是 | 5.2-20251226 公有云不存在 |
noDisturbIncall | 通话中免打扰。false:关闭，true:开启 | 5.2-20251226 公有云不存在 |
enableFecc | 允许远程遥控本地摄像头。false:关闭，true:开启 | 5.2-20251226 公有云不存在 |
错误码见小鱼RESTAPI错误码