希沃物联平台文档

自定义topic消息批量下发

此接口用于批量下发自定义topic消息。

1 接口路径

POST /api/v1/device/invoke/thing/pub/batch

2 请求参数

body参数，json格式：

名称 类型 是否必需 描述
productKey String 是 产品唯一标识
deviceIds BigInteger[] 是 设备ID列表，一次最多传入100个设备
method String 否 请求方法名
params Son 是 下发设备属性数据
version String 是 协议版本
topic String 是 要接收消息的Topic后半部分，如：
/user/8f84f648dde/258338227285417984/custom/r1/999/aaa/bbb -> /custom/r1/999/aaa/bbb
liveTime Integer 否 消息缓存时长（单位秒） 0为不缓存，最大值604800（7天）。当qos为1时，该值有效。
qos Integer 否 指定消息的发送方式。取值：0：最多发送一次。（设备不在线不会缓存消息）1：最少发送一次。（设备不在线会缓存消息）如果不传入此参数，则使用默认值0。

3 返回参数

统一返回参数说明参考：公共参数，正常的返回业务参数（data）为null。

4 返回状态码

公共状态码说明参考：公共参数，以下是业务关联的状态码说明：

code 描述
120401 topic不存在
120403 topic发布不支持特殊字符/topic无订阅权限

5 示例

请求示例

{
  "deviceIds": ["256095850432868352", "256095925250863104", "271675561393393664"],
  "liveTime": 600,
  "method": "string",
  "params": {
  	"color":12345
  },
  "productKey": "e4ceb4e874e",
  "qos": 0,
  "topic": "/custom/2/2/2",
  "version": "string"
}

返回示例

{
    "code": "000000",
    "data": null,
    "message": "success"
}