调用该接口查询设备分享记录,支持按照批次ID进行查询。

路径 /living/user/device/shared/record/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 6000

请求参数

名称 类型 是否必选 示例值 描述
batchId String 要查询的批次ID。
pageNo Int 当前页号,从1开始的页序号。
pageSize Int 页大小,单页的item数量上限,最大为 20。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

total Int

分享记录的总数。

pageNo Int

分页页码。

pageSize Int

分页大小。

data JSON

分享记录列表。

initiatorAlias String

发起分享用户的账号,手机号码或者邮箱地址。

receiverAlias String

被分享用户的账号,手机号码或者邮箱地址。

targetId String

共享的物的ID。

targetType String

共享的物的类型。

productImage String

设备产品图片。

deviceName String

设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。

isReceiver Int

当前用户是否是消息接收者。0:当前用户不是接收者(即表示当前用户是此消息的发起者);1:当前用户是接受者

gmtCreate Long

创建时间。

gmtModified Long

修改时间。

recordId String

分享记录唯一标识。

batchId String

分享批次ID。批量分享设备时,同一批次ID相同,客户端可以根据此判断是否为同一批分享,由此做聚合展示等。

status Int

状态 。-1:(表示初始化);0(表示同意);1(表示拒绝 );2(表示取消);3(表示过期);4(表示抢占);5(表示删除);6(表示发起者已解绑);99(表示异常)。

description String

描述。

categoryImage String

品类图标。

productName String

产品名称。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{
		"batchId": "value0",
		"pageNo": "value1",
		"pageSize": "value2"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        
      "gmtCreate": "15275845255",
      "gmtModified": "15235845255",
      "targetId": "fy2Z1oZFWxxxxxxxx0101edf00",
      "categoryImage": "http://xxx",
      "description": "向15163587365共享设备中,待对方确认",
      "targetType": "DEVICE",
      "recordId": "a1OwEjYxxxxdfdFJNb",
      "batchId": "ACCOUNT_DEV_SHARE_3fbd910a-xxxxxx-09aabf5fe5b5",
      "deviceName": "b65cb59xxxxxxxxxxcd695fb",
      "productName": "0dxxxx195",
      "initiatorAlias":"分享者",
      "receiverAlias":"被分享者",
      "isReceiver": 0,
      "status": -1
    }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}