Trigger External Conditions

Last Updated on : 2023-12-07 03:33:54download

Trigger external conditions to run an automation scene in the specified home.

API address

POST: /v1.0/homes/{home_id}/automations/{automation_id}/conditions/trigger

Parameter name	Type	IN	Required	Description
home_id	String	uri	true	The ID of the user's home.
automation_id	String	uri	true	The ID of the specified automation scene.

Description of body

Parameter name	Type	IN	Required	Description
entity_id	String	body	true	The ID of the specified external condition.
display	JSON	body	true	The condition that triggers an automation scene.

Description of display

Parameter name	Type	IN	Required	Description
code	String	body	true	The `statusCode` of the specified device.
value	String	body	true	The value of the specified code.

Parameter name	Type	Description
result	Boolean	Indicates whether the scene is triggered successfully. `true` is returned when the operation is successful.

POST: /v1.0/homes/242****/automations/53IYSXI3gEn2w***/conditions/trigger

[
  {
    "entity_id": "c9a5a524-d973-4b59-9390-0dcda0f17***",
    "display": {
      "code": "test",
      "value": "test"
    }
  }
]

{
    "result": true,
    "t": 1541072348540,
    "success": true
}

For more information, see error code.