分页获取企业下所有小鱼终端设备(硬终端)

功能说明

第三方可以调用该接口分页获取本企业下所有的小鱼硬终端设备信息

默认接口请求频率限制：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 (2023-0922版本）
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
category	String	Query	否	无	设备型号(例: NE60, AE350, 值为xylink查询所有小鱼终端，值为H323查询所有323终端，不传查询所有终端)	5.2 (2023-0922版本） 6.0（暂不支持传xylink和H323）
depCode	String	Query	否	无	部门编码（不传查询企业下所有，传0查询根部门下设备）	5.2 (2023-0922版本） 6.0暂不支持
callState	String	Query	否	无	设备呼叫状态（offline离线，idle空闲，incall呼叫中）	5.2 (2023-0922版本）（6.0暂不支持）
pageIndex	int	Query	否	0	页码	5.2 (2023-0922版本）
pageSize	int	Query	否	20	查询数量（最大100）	5.2 (2023-0922版本）

示例代码

返回成功结果示例：

{
    "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",
            "isOnline": false
        }
    ]
}

返回参数说明

参数名称	说明
page	当前页（pageIndex）
pageTotal	总页数
rowsTotal	数据总条数
rows	每页面显示条数（pageSize）
list	终端设备列表
name	设备名称
number	设备号
callState	设备在呼叫状态( incall呼叫中，idle空闲，offline离线或者未上报)
sn	设备sn
fitstBindtime	设备开机时间
portExpireTime	设备端口号到期时间
extendTime	设备延保到期时间
clientVersion	系统版本(如设备未正常注册，本字段会返回null，请尝试重新进行注册)
category	设备型号
departName	设备所属部门
depCodes	设备所属部门编码
internalIp	内部ip
externalIp	外部ip
isOnline	设备是否在线

错误码

错误码见小鱼RESTAPI错误码

2024-03-22 11:00:09

导出PDF文档