Send Property

Last Updated on : 2024-09-10 01:49:14

Based on the device ID, immediately send a property setting command to the specified device. When the device is offline, the sending process will fail.

API address

POST: /v2.0/cloud/thing/{device_id}/shadow/properties/issue

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Description of body

Parameter name	Type	IN	Required	Description
properties	String	body	true	The property to be supported by the device. In JSON parsable data, the key is the property code, and the value is the property value that is sent.

Return parameter

Parameter name	Type	Description
result	JSON	The returned result. Currently, no result is sent.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Long	The timestamp.
tid	String	The link ID.

Request example

POST: /v2.0/cloud/thing/372817193*****/shadow/properties/issue

{
  "properties": {
    "switch_1": true
  }
}

Return example

{
    "tid": "77a9807fb74411edb9d75a827c79edfd",
    "result": {
    },
    "t": 1677574021435,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocDevice Control

Next DocQuery Properties