Cloud Services API ReferenceAdvanced Device ServicesExtension APIsThird-Party Industry Device CapabilitiesPerimeter ServiceArm/DisarmArm/Disarm Host

Arm/Disarm Host

Last Updated on : 2023-06-20 14:54:09

Send a command to arm or disarm a specified host. After receiving the command, the perimeter host will implement the arming or disarming operation in a sub-area. Arming makes the alarm system in the normal alarm mode. When the alarm device and the defense zone work properly, the user can receive the alarms in real time, if any. Disarming makes the alarm system in the non-alarm mode. Even if the alarm device and defense zone can generate an alarm, the alarm information will not be uploaded to the alarm system, and the user cannot receive the alarm.

API address

POST: /v1.0/intrusion/{device_id}/actions/chan-action

Request parameter

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

Description of body

Parameter name	Type	IN	Required	Description
area_id	Long		true	The ID of a specified area.
armed	Boolean		true	Arm or disarm. Valid values: `true`: arm. `false`: disarm.

Return parameter

Parameter name	Type	Description
result	CmdIssueResultResponse	The returned result.

Description of result

Parameter name	Type	Description
sn	String	The command record ID.

Request example

POST: /v1.0/intrusion/6ce****/actions/chan-action

{
  "areaId": "573****",
  "armed": true
}

Return example

{
    "result": {
        "sn": "133****"
    },
    "t": 1561456817168,
    "success": true
}

Error code

For more information, see error code.

Prev DocArm/Disarm

Next DocBypass/Resume