消息推送接口
订阅设备资源
- 接口说明
接口名称：config.resource.subscribe
接口描述：当设备状态发生变化时，会将对应资源值数据上报到云端，若开发者配置了消息推送功能，那么绿米云会将设备数据推送到第三方服务器。由于设备数据量庞大，若不需要接收所有设备数据，开发者可通过订阅资源接口来指定需接收的设备资源数据。
订阅资源需要搭配消息推送功能来使用，详细消息推送功能说明，请参考消息推送。
- 请求参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| resources | List | 是 | 数组，详见resources说明 |
resources说明
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| subjectId | String | 是 | 对象id |
| resourceIds | Array(String) | 是 | 资源id数组，详见设备资源页面 |
| attach | String | 否 | 附加信息-推送时带上 |
- 请求示例
{
"intent": "config.resource.subscribe",
"data": {
"resources": [
{
"subjectId": "virtual2.11774113824794",
"resourceIds": [
"4.1.85","14.1.85"
],
"attach":"haha"
}
]
}
}
返回参数：无
返回示例
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": null
}
取消订阅设备资源
- 接口名称：config.resource.unsubscribe
接口描述：取消指定设备的资源ID订阅。
请求参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| resources | List | 是 | 数组，详见resources说明 |
resources说明
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| subjectId | String | 是 | 对象id |
| resourceIds | Array | 是 | 资源id数组，详见设备资源页面 |
- 请求示例
{
"intent": "config.resource.unsubscribe",
"data": {
"resources": [
{
"subjectId": "virtual2.11774113824794",
"resourceIds": [
"4.1.85","14.1.85"
]
}
]
}
}
返回参数：无
返回示例
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": null
}
查询推送失败的消息数据详情
- 接口名称：query.push.errorMsg
- 接口描述：本接口用于查询推送失败的消息数据详情。仅支持查询近12小时内的消息数据。
- 请求参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| appId | String | 是 | 应用id |
| openId | String | 否 | 用户唯一标识 |
| msgType | String | 否 | 消息类型，0-事件推送 1-属性推送 |
| startTime | Long | 否 | 开始时间戳，默认当前时间12小时前 |
| endTime | Long | 否 | 结束时间戳，默认当前时间 |
| size | Integer | 否 | 每次拉取数据数量 |
| scanId | String | 否 | 上一次请求返回的scanId，不传则从数据起始处开始查询 |
- 请求参数
{
"intent": "query.push.errorMsg",
"data": {
"appId":"8971234912asd32",
"openId": "78321978321123",
"msgType": "resource_report",
"startTime": 1612321342000,
"endTime": 167845478000,
"size": 1,
"scanId":"81237821323"
}
}
- 返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| appId | String | 应用id |
| openId | String | 用户唯一标识 |
| pushTime | Integer | 推送时间 |
| content | Integer | 推送内容 |
| msgType | Integer | 消息类型，0-事件推送 1-属性推送 |
- 返回示例
{
"code": 0,
"requestId": "",
"message": "Success",
"msgDetails": null,
"result": {
"scanId": "12376127632232",
"msg": [
{
"appId": "85729407462685491210c04a",
"openId": "352922007642857296055698141185",
"pushTime": 1625046378517,
"content": "{\"data\":[{\"resourceId\":\"4.1.85\",\"statusCode\":0,\"subjectId\":\"virtual2.63697334426607\",\"time\":\"1625046376627\",\"triggerSource\":{\"time\":\"1625046376\",\"type\":4},\"value\":\"0\"}],\"msgId\":\"AC120001000A18B4AAC29928A0E82DD41\",\"msgType\":\"resource_report\",\"openId\":\"352922007642857296055698141185\",\"time\":\"1625046378516\"}",
"msgType": resource_report
}
]
}
}