Cloud Services API ReferenceAdvanced Device ServicesExtension APIsThird-Party Industry Device CapabilitiesPerimeter ServiceBypass/ResumeBypass/Resume

Bypass/Resume

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

Send a command to bypass or resume a specified perimeter device. After receiving the command, the perimeter device will implement the bypass or resuming operation. Bypassing is a separate operation for one or several specific devices in the area. The bypassed devices in the area will not send an alarm. Resuming means that a device in the area changes from the bypassed status to the normal status.

API address

POST: /v1.0/intrusion/{device_id}/actions/by-pass

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
by_pass	Boolean		true	Specifies whether to bypass or resume a specified device. Valid values: `true`: bypass. `false`: resume.

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/by-pass

{
  "byPass": false
}

Return example

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

Error code

For more information, see error code.

Prev DocBypass/Resume

Next DocMute Group