Loading...

    获取某个小鱼终端的状态

    功能说明

    这个 API 列表用于获取一个企业内某台小鱼终端的状态。目前包括如下三个呼叫状态：

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

    实现方法

    REST URL 

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


    请求参数说明:

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    version

    String

    Path

    是

    无

    传v1即可


    enterpriseId

    String

    Query

    是

    无

    企业ID，通过​管理平台-云视讯API​​获得


    signature

    String

    Query

    ​​​​​​签名鉴权1.0（旧）​​：是

    ​​签名鉴权2.0​​：否

    无

    API签名，参考

    ​​签名鉴权​​


    number

    String

    Query

    是

    无

    设备号

    3.9

    示例代码

    结果示例

    请求成功返回结果示例

    {
      "callState": "offline/idle/incall",
      "deviceSN": "2D15100905B343XX",
      "number": "432703"
    }

    返回参数说明:

    参数

    说明

    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错误码​​

    2024-03-22 10:45:04
    导出PDF文档
    意见反馈