Access control action execution

Last Updated on : 2025-05-30 01:56:03download

API List

Request method	API	Description
POST	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/actions/open	Open the door remotely
POST	/v1.0/iot-02/third/doors/{device_id}/persons/actions/call	Call residents, support calling multiple residents at the same time

Open the door remotely

API Description

Used to open the door remotely through the app.

API Address

POST /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/actions/open

Request Parameters

Parameter	Type	Position	Description	Mandatory
device_id	String	URI	Tuya Device ID	Yes
person_id	String	URI	Tuya Person ID, which contains a maximum of 32 characters.	Yes

Request Example

POST /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/actions/open

Response Parameters

Parameter	Type	Description
code	Integer	Response code (See the error code section for details)
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
result	Object	Result object.

*Parameters in result

Parameter	Type	Description
sn	String	Instruction record ID, one instruction record ID corresponds to one instruction set

Success Response Example

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

Call residents

API description

The user calls the owner on the video door. After receiving the call event, the partner queries the owner list according to the room number, and provides the owner list to Tuya through this interface, and Tuya initiates a call or hangs up to the residential app. Currently, up to 3 residents can be called at the same time.

API address

POST /v1.0/iot-02/third/doors/{device_id}/persons/actions/call

Request Parameters

Parameter	Type	Position	Description	Mandatory
device_id	String	URI	Device ID	Yes
sn	String	BODY	sn number,which contains a maximum of 20 characters.	Yes
type	Integer	BODY	Operation type, refer to call event	Yes
target_address	String	BODY	Called room number, refer to call event	No
person_id_list	List	BODY	List of person IDs of the called Tuya users, which contains a maximum of 32 characters.	Yes

Request Example

POST /v1.0/iot-02/third/doors/002dj00118fe34d9****/users/actions/call
{
  "sn": "1212581947449081856",
  "type": 1,
  "target_address": "01-01-01-01-01-01",
  "person_id_list": ["ay1563240766201z****","ay1563240766Jw30****"]
}

Response Parameters

Parameter	Type	Description
code	Integer	Response code (See the error code section for details)
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
result	Object	Result object

result Description

Parameter	Type	Description
device_id	String	Tuya Device ID

Success Response Example

{
    "success": true,
    "t": 1561456817168,
    "result": {
      "device_id":"002dj00118fe34d9****"
    }
}

Prev DocUser QRCode Management

Next DocOnline Card Issuance