Facial Photo Management

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

API List

Method of Request	API	Description
POST	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}	Add customer facial photo information
PUT	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}	Modify customer facial photo information
DELETE	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}	Delete customer facial photo information

Add customer facial photo information

POST /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}

Parameter	Type	Position	Description	Mandatory
device_id	String	URI	Device ID	Yes
person_id	String	URI	Tuya user ID, no more than 32 letters	Yes
face_id	String	URI	Facial ID, no more than 32 letters	Yes
url	String	BODY	url to facial photo, photo format: jpg, file size no bigger than 1M	Yes

POST  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/faces/12345
{
 "url":"http://xxxx.jpg"
}

Parameter	Type	Description
code	Integer	Responding code (Please see error codes for more 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	Tuye	Instruction
sn	String	Command record ID, one command record ID has one corresponding string of command

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

Modify user facial photo information

PUT /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}

Parameter	Type	Position	Description	Mandatory
device_id	String	URI	Device ID	Yes
person_id	String	URI	Tuya user ID, no more than 32 letters	Yes
face_id	String	URI	Facial ID, no more than 32 letters	Yes
url	String	BODY	url to facial photo, photo format: jpg, file size no bigger than 1M	Yes

PUT  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/faces/12345
{
  "url":"http://xxxx.jpg"
}

Parameter	Type	Description
code	Integer	Responding code (Please see error codes for more 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 Parameter

Parameter	Type	Instruction
sn	String	Command record ID, one command record ID has one corresponding string of command

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

Delete user facial photo information

DELETE /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/faces/{face_id}

Parameter	Type	Postion	Description	Mandatory
device_id	String	URI	Device ID	Yes
person_id	String	URI	Tuya user ID, no more than 32 letters	Yes
face_id	String	URI	Facial ID, no m ore than 32 letters	Yes

DELETE  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/faces/12345

Parameter	Type	Description
code	Integer	Responding code (Please see error codes for more details)
success	Boolean	Is this request successful True: Successful, False: Fail
msg	String	Exception message.It is null when the request result is success.
result	Object	Result object.

Result Description

Parameter	Type	Description
sn	String	Command record ID, one command record ID has one corresponding string of command

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