调用该接口获取共享通知列表。
路径 | /uc/getShareNoticeList |
版本号 | 1.0.9 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
pageNo | Int | 是 | 1 | 当前页号,从1开始的页序号。 |
pageSize | Int | 是 | 100 | 页大小,单页item的数量上限,最大值为200。如果传入的值超过200,系统会自动按照200条来查询。 |
groupBy | String | 否 | BATCH | 是否按照批次的方式来获取通知列表,默认是NONE。可取值为:NONE(表示不作 groupBy 处理);BATCH(表示同一批次的分享只会有一条通知)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
total | Int |
记录总数量。 |
|
pageNo | Int |
分页页码。 |
|
pageSize | Int |
分页大小。 |
|
data | JSON |
共享记录列表。 |
|
initiatorAlias | String |
发起分享用户的账号,优先展示昵称,在没有昵称的情况下为手机号码或者邮箱地址。 |
|
receiverAlias | String |
被分享用户的账号, 优先展示昵称,在没有昵称的情况下为手机号码或者邮箱地址。 |
|
targetId | String |
共享的物的ID。按照BATCH查询时,如果批次内有多个记录,此字段不会返回。 |
|
targetType | String |
共享的物的类型。 |
|
productImage | String |
设备产品图片。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 按照BATCH查询时,如果批次内有多个记录,此字段不会返回。 |
|
isReceiver | Int |
当前用户是否是消息接收者。0(表示当前用户是此消息的发起者);1(表示当前用户是接收者)。 |
|
gmtCreate | Long |
创建时间。 |
|
gmtModified | Long |
修改时间。 |
|
recordId | String |
分享记录唯一标识。按照BATCH查询时,如果批次内有多个记录,此字段不会返回。 |
|
batchId | String |
分享批次ID。批量分享设备时,同一批次ID相同,客户端可以根据此判断是否为同一批分享,由此做聚合展示等。 |
|
status | Int |
状态 。-1:(表示初始化);0(表示同意);1(表示拒绝 );2(表示取消);3(表示过期);4(表示抢占);5(表示删除);6(表示发起者已解绑);99(表示异常)。 |
|
description | String |
描述。 |
|
categoryImage | String |
品类图标。 |
|
productName | String |
产品名称。 |
|
batchInfo | JSON |
批次信息。如果批次内包含多个记录,此字段不为空,其中包含了该批次的信息。 |
|
recordCount | Int |
当前批次中所包含的分享记录的数量。例如在一个批次中分享了 10 个设备,那么对应包含有 10 个分享记录。 |
|
nodeType | String |
设备节点类型(可为空/null),取值范围(DEVICE:子设备;GATEWAY:网关。) |
|
initiatorIdentityId | String |
发起分享用户的账号id。 |
|
receiverIdentityId | String |
被分享用户的账号id。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.9",
"iotToken": "token"
},
"params":{
"pageNo":1,
"pageSize":100,
"groupBy": "BATCH"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": [
{
"initiatorIdentityId":"aef3wwee*5435",
"receiverIdentityId":"y2Z1oZFWxxxxxxxx0101",
"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
}
],
"id": "e2d74ffe-308e-xxxx-xxxx-9b44a43eabc9"
}
异常返回示例
JSON
格式
{
"code":2062,
"id":"4fa207ca-fffd-xxxx-xxxx-e6f7ca6c99c3",
"localizedMsg":"请求错误",
"message":"identityId not exist"
}