调用该接口获取共享设备的告警提醒配置。
路径 | /living/device/global/notice/sharing/config/get |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
targetIdentityId | String | 是 | 5082opabf5192********980ae6f6093 | 被分享者的统一身份ID。 |
iotId | String | 是 | D95D2****E4F31A2697 | 设备ID。生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误信息。 |
|
data | String |
通知模式。NONE(表示完全关闭);MESSAGE(表示仅能查询消息,不会推送消息弹窗);MESSAGE_AND_NOTICE(表示既能查询消息, 也会推送消息弹窗),如果用户之前从未配置过告警提醒配置,则默认为 MESSAGE_AND_NOTICE。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"targetIdentityId": "5082opabf5192********980ae6f6093",
"iotId": "D95D2****E4F31A2697"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-****-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "MESSAGE_AND_NOTICE"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}