Query Group Status

Last Updated on : 2024-06-29 02:33:53download

Query the group status based on the group ID. The status of any device in the group is returned.

API address

GET: /v2.1/cloud/thing/group/{group_id}/status-set

Request parameter

Parameter name	Type	IN	Required	Description
group_id	Long	path	true	The group ID.

Return parameter

Parameter name	Type	Description
result	JsonObject	The returned result of the specified group.
success	Boolean	Indicates whether the API is called successfully. Valid values: `true`: The API call succeeded. `false`: The API call failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
code	String	The code of the specified instruction.
type	String	The type of the specified instruction.
value	String	The current value of the specified instruction.

Request example

GET: /v2.1/cloud/thing/group/1393****/status-set

Return example

{
    "tid": "1e90681f022611efbe7a366d87620758",
    "result": [
        {
            "code": "work_mode",
            "type": "enum",
            "value": "music"
        },
        {
            "code": "switch_led",
            "type": "bool",
            "value": "true"
        }
    ],
    "t": 1713954823138,
    "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 DocQuery Group Task Progress

Next DocRemove Devices