根据 SN或终端号列表获取状态信息

功能说明

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

实现方法

REST URL

PUT https://sdk.xylink.com/api/rest/external/{version}/deviceInfo?queryType=number&enterpriseId=XXX&signature=XXX

请求参数说明:

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可	5.2-20221220 公有云
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2-20221220 公有云
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权	5.2-20221220 公有云
queryType	String	Query	否	sn	默认是按sn查询，当queryType为number时，按number批量查询	5.2-20251226 公有云不存在
Param of Body	String of Array	Body	否	无	终端sn数组或number数组，5.2-20251226迭代之前，只支持sn数组	5.2-20221220 公有云

示例代码

请求示例

请求消息体示例（Json）

["2D15100905B343XX", "2D15100905B344XX"]

结果示例

请求成功返回结果示例

[
  {
    "callState": "offline/idle/incall",
    "deviceSN": "2D15100905B343XX",
    "number": "432703"
  },
  {
    "callState": "offline/idle/incall",
    "deviceSN": "2D15100905B342XX",
    "number": "432704"
  }
]

返回参数说明:

参数	说明
callState	设备状态： offline 离线， idle 空闲， incall 呼叫中
deviceSN	终端sn
number	终端号

请求失败结果示例

{
    "developerMessage": "ErrorStatus: SDK_INVALID_APPKEY No app found for extId: ",
    "userMessage": "sdk.invalid.key",
    "errorCode": 60001,
    "moreInfo": "http://www.com.ainemo.com/errors/60001"
}

错误码

错误码见小鱼RESTAPI错误码

2025-09-25 17:02:02

导出PDF文档