调用DescribeDeviceOnlineInfo根据设备或者账号ID(token)查询设备在线详情。

说明
当指定deviceId或者deviceToken时,可判断具体设备是否在线。

调试

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

调试

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
Action String DescribeDeviceOnlineInfo

系统规定参数。取值:DescribeDeviceOnlineInfo

ProjectId String sghghshr

iovcc项目工程ID。

Type String deviceId

查询条件类型。取值:

  • deviceToken
  • deviceId
  • iasToken
  • iasId
Value String c86b36f1d19c488f9ae3798f332b9fd5

查询对象。

表示查询条件类型的对应值。

RegionId String cn-shanghai

地域ID。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
Devices Array of Devices

设备在线详情列表。

ClientVersion String 2.1.0.1.20170327

cmns客户端版本

DeviceId String fc71429ddd9b473c81d7ef5f33ab10cc

dis系统设备ID

IasId String 123xxxxxxxxxxx

ias系统账号ID

LoginTime Long 1525701500000

最近联网时间

Online Integer 1

设备是否在线。

1表示在线,0表示不在线,-1表示设备不存在。

ProjectId String gsgshhfs

iovcc项目工程ID

SystemVersion String 5.3.0

系统版本

Terminal String iphone7

设备机型

RequestId String 629586FE-CB2E-4742-995E-121F952CEB72

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDeviceOnlineInfo
&ProjectId=sghghshr
&Type=deviceId
&Value=c86b36f1d19c488f9ae3798f332b9fd5
&<公共请求参数>

正常返回示例

XML格式

<DescribeDeviceOnlineInfoResponse>
	  <Devices>
		    <DeviceId>6c845cc9c4fe11138aff5be5e0aeebjj</DeviceId>
		    <Terminal>iphone8</Terminal>
		    <IasId></IasId>
		    <ProjectId>PYNNN9KS</ProjectId>
		    <ClientVersion>2.3.0.4.20170217</ClientVersion>
		    <SystemVersion>1.0.1-E-20180330.1343</SystemVersion>
		    <Online>0</Online>
		    <LoginTime>1523452482291</LoginTime>
	  </Devices>
	  <RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>
</DescribeDeviceOnlineInfoResponse>

JSON格式

{
  "Devices": [
    {
      "DeviceId": "6c845cc9c4fe11138aff5be5e0aeebjj",
      "Terminal": "iphone8",
      "IasId": "",
      "ProjectId": "PYNNN9KS",
      "ClientVersion": "2.3.0.4.20170217",
      "SystemVersion": "1.0.1-E-20180330.1343",
      "Online": 0,
      "LoginTime": 1523452482291
    }
  ],
  "RequestId": "629586FE-CB2E-4742-995E-121F952CEB72"
}

错误码

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