设备接入 IOTDA-下发设备消息:请求参数
下载设备接入 IOTDA用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
message_id |
否 |
String |
参数说明：消息id，由用户生成（推荐使用UUID），同一个设备下唯一， 如果用户填写的id在设备下不唯一， 则接口返回错误。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 最大长度：128 |
name |
否 |
String |
参数说明：消息名称。 取值范围：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最大长度：128 |
message |
是 |
Object |
参数说明：消息内容，支持string和json格式。 |
properties |
否 |
PropertiesDTO object |
参数说明：消息下行到设备的属性参数。 |
encoding |
否 |
String |
参数说明：消息内容编码格式。默认值none。 取值范围：
缺省值：none |
payload_format |
否 |
String |
参数说明：有效负载格式，在消息内容编码格式为none时有效。默认值standard（平台封装的标准格式）。 取值范围：
缺省值：standard |
topic |
否 |
String |
参数说明：消息下行到设备的自定义topic后缀, 可选， 仅适用于MQTT协议接入的设备。 用户只能填写在租户产品界面配置的topic, 否则会校验不通过。 平台给消息topic添加的前缀为$oc/devices/{device_id}/user/， 用户可以在前缀的基础上增加自定义部分， 如增加messageDown，则平台拼接前缀后完整的topic为 $oc/devices/{device_id}/user/messageDown，其中device_id以实际设备的网关id替代。 如果用户指定该topic，消息会通过该topic下行到设备，如果用户不指定， 则消息通过系统默认的topic下行到设备,系统默认的topic格式为： $oc/devices/{device_id}/sys/messages/down。此字段与topic_full_name字段只可填写一个。 最大长度：128 |
topic_full_name |
否 |
String |
参数说明：消息下行到设备的完整topic名称, 可选。用户需要下发用户自定义的topic给设备时，可以使用该参数指定完整的topic名称， 物联网平台 不校验该topic是否在平台定义，直接透传给设备。设备需要提前订阅该topic。此字段与topic字段只可填写一个。 最大长度：128 |
ttl |
否 |
Integer |
参数说明：下发消息在平台缓存的老化时间，时间单位是分钟，默认值1440；ttl参数数值必须是5的倍数，即以5分钟为粒度；指定为0时表示不缓存消息，默认最大缓存时间为1440分钟，缓存时间超过1440分钟需申请，否则下发失败。 最小值：0 最大值：10080 缺省值：1440 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
correlation_data |
否 |
String |
参数说明：MQTT 5.0版本请求和响应模式中的相关数据，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的相关数据。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
response_topic |
否 |
String |
参数说明：MQTT 5.0版本请求和响应模式中的响应主题，可选。用户可以通过该参数配置MQTT协议请求和响应模式中的响应主题。 取值范围：长度不超过128, 只允许字母、数字、以及_-?=$#+/等字符的组合。 最大长度：128 |
user_properties |
否 |
Array of UserPropDTO objects |
参数说明：用户自定义属性，可选。用户可以通过该参数配置用户自定义属性。可以配置的最大自定义属性数量为20。 |
