Send Group Properties

Last Updated on : 2024-06-29 01:00:18download

Send group properties based on the group ID. That is to say, send control instructions to the devices in the specified group.

API address

POST: /v2.1/cloud/thing/group/{group_id}/properties

Request parameter

Parameter nameTypeINRequiredDescription
group_idLongpathtrueThe group ID.

Description of body

Parameter nameTypeINRequiredDescription
propertiesStringbodytrueThe properties of the specified group, that is, a set of instructions.

Return parameter

Parameter nameTypeDescription
resultJsonObjectThe returned result of the specified group.
successBooleanIndicates whether the API is called successfully. Valid values:
  • true: The API call succeeded.
  • false: The API call failed.
tLongThe timestamp.
tidStringThe link ID.

Description of result

Parameter nameTypeDescription
resultBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.

Request example

POST: /v2.1/cloud/thing/group/1393****/properties
{
  "properties": "{\"work_mode\":\"music\", \"switch_led\": true}"
}

Return example

{
    "tid": "4ab1341e022111efbe7a366d87620758",
    "result": {
        "result": true
    },
    "t": 1713952748467,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.