调用该接口拉取指定用户的共享设备的告警消息开关配置。只有配置为进行App应用推送的告警信息才会被获取到,同时只有设备所有者才能使用这个接口。
路径 | /message/center/device/notice/sharing/config/list |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 10000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | aD12ef8Kk****EiNJJ001082 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
identityId | String | 是 | value | 被分享者的统一身份ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
noticeEnabled | Boolean |
消息推送提醒开关。取值为:true(表示开启);false(表示关闭)。如果您之前从未配置过告警提醒配置,则默认返回true。 |
|
eventId | String |
告警事件的ID。 |
|
eventName | String |
告警事件的名称。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"iotId": "aD12ef8Kk****EiNJJ001082",
"identityId": "value"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": [
{
"eventId" : "18012",
"eventName": "开门提醒",
"noticeEnabled" : true
},
{
"eventId" : "18013",
"eventName": "劫持报警",
"noticeEnabled" : false
}
]
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}