调用ListDevices获取设备列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
UserId	string	是	坐席 ID。	agent@ccc-test

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Params	array	响应参数列表。
Param	string	响应参数。	无
Data	array<object>	设备列表。
Device	object	设备信息。
Extension	string	坐席分机号。	8032****
Expires	long	设备注册过期时间，格式为 Unix 时间戳，单位毫秒，如果设备过期未重新注册，则会导致设备离线。	1609118499750
Contact	string	设备地址信息。	sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4
DeviceId	string	设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。	ACC-YUNBS-1.0.10-****
UserId	string	坐席 ID。	agent@ccc-test
CallId	string	设备发起的注册信令中的 Call ID。	d7b818c3-8d3a-732f-bc9e-1782wa16****
InstanceId	string	实例 ID。	ccc-test
DeviceType	string	设备类型	CHAT

示例

正常返回示例

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": "CHAT"
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2023-11-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情