文档

ListDevices - 获取设备列表

更新时间:

调用ListDevices获取指定实例下指定坐席的设备列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
UserIdstring

坐席 ID。

agent@ccc-test

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Paramsarray

响应参数列表。

string

响应参数。

Dataobject []

设备列表。

Extensionstring

坐席分机号。

8032****
Expireslong

设备注册过期时间,格式为 Unix 时间戳,单位毫秒,如果设备过期未重新注册,则会导致设备离线。

1609118499750
Contactstring

设备地址信息。

sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4
DeviceIdstring

设备 ID,浏览器 WebRTC 软电话或实体话机设备的标识 ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
UserIdstring

坐席 ID。

agent@ccc-test
CallIdstring

设备发起的注册信令中的 Call ID。

d7b818c3-8d3a-732f-bc9e-1782wa16****
InstanceIdstring

实例 ID。

ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": [
    {
      "Extension": "8032****",
      "Expires": 1609118499750,
      "Contact": "sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "CallId": "d7b818c3-8d3a-732f-bc9e-1782wa16****",
      "InstanceId": "ccc-test",
      "DeviceType": ""
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
403Permission.UserYou have no permission to access user(s) %s.您无权访问这些用户。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈