开发者中心 - 小鱼易连

一、分页获取企业下所有硬终端

功能说明

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

默认接口请求频率限制：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：呼叫中， unactivated：未激活	5.2-20230922 公有云（20260327 新增unactivated）
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,
            "gatewayDeviceId":"1003"
        }
    ]
}

返回参数说明

参数名称	说明
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	设备在呼叫状态 offline：离线， idle：空闲， incall：呼叫中， unactivated：未激活	5.2-20230922 公有云（20260327 新增unactivated）
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 公有云不存在
gatewayDeviceId	h323 avc mcu id	5.2-20261225 公有云不存在

错误码

错误码见小鱼RESTAPI错误码

二、硬终端分页游标查询

功能说明

按游标分页查询企业硬终端，支持分级分权下查询部门及子部门。与（一）相比，增加了needAll参数，needAll=false 只查当前部门，true 包含全部子部门。

首次请求省略 cursor 或传空字符串。后续请求将上次响应的 nextCursor 原样传回。hasMore=false 时结束，nextCursor 为空字符串。需要重新遍历时清空 cursor。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET https://sdk.xylink.com/api/rest/external/v1/device/query/page/scroll?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	已开通 SDK 的外部企业标识；企业身份，沿用 SDK 鉴权规则	公有云不支持分区云5.2-20261225
signature	String	Query	签名方式要求时必填	无	按 SDK 签名规则计算；示例采用 Query signature；其他已支持的签名方式沿用其参数规则	公有云不支持分区云5.2-20261225
depCode	String	Query	否	无	部门编号；0 表示根部门；分极分权下默认为应用关联部门	公有云不支持分区云5.2-20261225
needAll	Boolean	Query	否	false	仅接受小写 true、false；指定部门时是否包含全部子部门	公有云不支持分区云5.2-20261225
callState	String	Query	否	无	offline、idle、incall、unactivated；忽略大小写；分别表示离线、在线空闲、通话中、未激活；缺省、空串或纯空白表示不筛选；非空值不自动去除两端空格	公有云不支持分区云5.2-20261225
cursor	String	Query	否	无	首次省略或传空串；后续传上次 nextCursor；结束后不要再次用空游标续查，否则将重新开始	公有云不支持分区云5.2-20261225
pageSize	Integer	Query	否	20	1–100，包含边界；空串、空白、非整数或越界均非法；每次最多返回的记录数，不是页码	公有云不支持分区云5.2-20261225

响应结果示例（HTTP 200）

{
    "hasMore": false,
    "nextCursor": "",
    "rowsTotal": 1,
    "pageTotal": 1,
    "rows": 1,
    "list": [
        {
            "name": "示例硬终端",
            "number": "900001",
            "callState": "idle",
            "sn": "EXAMPLE-SN-001",
            "firstBindTime": "1700000000000",
            "clientVersion": "EXAMPLE_VERSION",
            "category": "H323",
            "departName": [
                "示例部门"
            ],
            "depCodes": [
                "EXAMPLE_DEPT"
            ],
            "internalIp": "10.0.0.10",
            "externalIp": "192.0.2.10",
            "isOnline": true,
            "allowNemoNumberCall": null,
            "allowOutgoingCall": null,
            "autoAnswer": null,
            "showRecordingIndicator": null,
            "noDisturbIncall": null,
            "enableFecc": null,
            "gatewayDeviceId":"1003"
        }
    ]
}

响应参数说明

参数	参数类型	说明	初始平台
hasMore	Boolean	true / false；是否还有下一批；false 表示遍历结束	公有云不支持分区云5.2-20261225
nextCursor	String	有下一批时非空；结束时为空字符串；后续请求的 cursor，须原样传回	公有云不支持分区云5.2-20261225
rowsTotal	Long	大于或等于 0；当前筛选条件命中的总记录数，不是游标之后的剩余数量	公有云不支持分区云5.2-20261225
pageTotal	Integer	rowsTotal / pageSize 向上取整；批次数统计；无结果时为 0；不提供按页码跳转能力	公有云不支持分区云5.2-20261225
rows	Integer	0–pageSize；本次 list 的记录数	公有云不支持分区云5.2-20261225
list	List	本批终端列表；无结果时为 []	公有云不支持分区云5.2-20261225
└name	String	终端名称；	公有云不支持分区云5.2-20261225
└number	String	终端号码；	公有云不支持分区云5.2-20261225
└callState	String	offline、idle、incall、unactivated；离线、在线空闲、通话中、未激活；缺失或无法识别的状态映射为 offline	公有云不支持分区云5.2-20261225
└sn	String	终端 SN；	公有云不支持分区云5.2-20261225
└firstBindTime	String	时间戳字符串或空字符串；设备绑定时间；无对应设备信息时为空字符串	公有云不支持分区云5.2-20261225
└clientVersion	String	终端软件版本；	公有云不支持分区云5.2-20261225
└category	String	设备型号；	公有云不支持分区云5.2-20261225
└departName	List	所属部门名称信息；	公有云不支持分区云5.2-20261225
└depCodes	List	所属部门编号列表；	公有云不支持分区云5.2-20261225
└internalIp	String	终端内部 IP；	公有云不支持分区云5.2-20261225
└externalIp	String	终端外部 IP；	公有云不支持分区云5.2-20261225
└isOnline	Boolean	true / false；idle、incall 为 true；offline、unactivated 为 false	公有云不支持分区云5.2-20261225
└allowNemoNumberCall	Integer	0：关闭；1：所有用户；2：通讯录用户；3：非匿名用户；被呼叫范围；	公有云不支持分区云5.2-20261225
└allowOutgoingCall	Integer	0：关闭；1：所有用户；2：通讯录用户；主动呼叫范围；	公有云不支持分区云5.2-20261225
└autoAnswer	Integer	0：关闭；1：所有用户；2：通讯录用户；自动应答范围；	公有云不支持分区云5.2-20261225
└showRecordingIndicator	Boolean	true / false；是否显示录制提示；	公有云不支持分区云5.2-20261225
└noDisturbIncall	Boolean	true / false；是否开启通话中免打扰；	公有云不支持分区云5.2-20261225
└enableFecc	Boolean	true / false；是否允许远程遥控本地摄像头；	公有云不支持分区云5.2-20261225
└gatewayDeviceId	String	h323 avc mcu id	5.2-20261225 公有云不存在

错误码

以下仅列出各接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码

错误码	描述
1001	needAll must be true or false
1001	pageSize must be an integer between 1 and 100
1001	unsupported callState
696400	cursor 错误
1001	invalid depCode
4001038	ext.opened.only.dep.resource

2026-10-23 10:16:08

导出PDF文档