更新时间:2022-02-24 GMT+08:00

设备服务信息变化通知

典型场景

第三方应用在物联网平台订阅了设备服务信息变化通知后(订阅的通知类型为serviceInfoChanged),当平台向设备下发命令修改设备服务信息时,平台会向第三方应用推送通知消息。

接口功能

支持物联网平台向订阅了设备服务信息变化通知的第三方应用推送通知消息。

注意事项

  1. 应用在订阅平台业务数据时需要订阅接口描述中的指定回调地址,回调地址中的server与port为应用服务器公网地址与服务器配置中指定的端口。
  2. 应用通过PushMessageReceiver类并重写回调接口接收推送消息的内容。
  3. 如果回调地址不是应用服务器本身的地址,则第三方应用需要自己实现原始回调接口,接口内容请参考IoT平台北向API参考中的消息推送章节。

接口描述

回调地址

https://server:port/v1.0.0/messageReceiver

回调接口

def handleServiceInfoChanged(self)

接口所属类

PushMessageReceiver

参数说明

入参是request.json

参数

必选/可选

类型

位置

描述

nsicDTO

必选

NotifyServiceInfoChangedDTO

body

见下表NotifyServiceInfoChangedDTO的描述。

NotifyServiceInfoChangedDTO

参数

必选/可选

类型

位置

描述

notifyType

必选

Enum

body

通知类型,取值:“serviceInfoChanged”

deviceId

必选

String

body

设备ID,用于唯一标识一个设备。

gatewayId

必选

String

body

网关ID,用于唯一标识一个网关设备。

serviceId

必选

String

body

设备服务标识。

serviceType

必选

String

body

设备服务类型。

serviceInfo

必选

ServiceInfo

body

设备服务信息,增量上报,具体参见ServiceInfo结构体。

ServiceInfo结构体说明:

参数

必选/可选

类型

位置

描述

muteCmds

可选

List<String>

body

屏蔽的设备控制命令列表。

响应参数

Status Code: 200 OK

请求示例

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"serviceInfoChanged",
    "deviceId":"*******",
    "serviceId":"*******",
    "serviceType":"*******",
    "gatewayId":"*******",
    "serviceInfo":{
        "muteCmds":"VIDEO_RECORD"
    }
}

响应示例

response:
Status Code: 200 OK