Access Card Management

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}/card/{card_no} Add access card information
PUT /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no} Modify access control card information
DELETE /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no} Delete access control card information
PUT /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}/freeze Freeze access card
PUT /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}/unfreeze Unfreeze access card

Add access card information

API Description

Add access card information

API Address

POST	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}

Request Parameter

Parameter Type Position Description Mandatory
device_id String URI Device ID Yes
person_id String URI Tuya User id, no more than 32 characters Yes
card_no String URI Access card number Yes

Request Example

POST	/v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/card/d9e2816da0f54**

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
sn String command record id,One command record id corresponds to one command set

Example of Result Object

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

Modify access control card information

API Description

Modify access control card information

API Address

PUT	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}

Request Parameters

Request Parameters Type Position Description Mandatory
device_id String URI Device id Yes
user_id String URI Tuya User ID,No more than 32 characters Yes
card_no String URI Access card number Yes

Request Example

PUT	/v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/card/d9e2816da0f54**

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
sn String command record ID, one command record id corresponds to one command set

Example of Result Object

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

Delete access control card information

API Description

Delete access control card information

API Address

DELETE /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}

Request Parameters

Request Parameters Type Position Description Mandatory
device_id String URI Device ID Yes
person_id String URI Tuya User ID, no more than 32 characters Yes
card_no String URI Access card number Yes

Request Example

DELETE  /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/card/d9e2816da0f54**

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
sn String command record ID,One command record id corresponds to one command set

Example of Result Object

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

Freeze access card

API Description

Freeze access card

API Address

PUT	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}/freeze

Request Parameters

Request Parameters Type Position Description Mandatory
device_id String URI Device ID Yes
person_id String URI Tuya User ID, no more than 32 characters Yes
card_no String URI Access card number Yes

Request Example

POST	/v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/card/d9e2816da0f54**/freeze

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
sn String command record ID, one command record id corresponds to one command set

Example of Result Object

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

Unfreeze access card

API Description

Unfreeze access card

API Address

PUT	/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/card/{card_no}/unfreeze

Request Parameters

Request Parameters Type Position Description Mandatory
device_id String URI Device id Yes
person_id String URI Tuya User id,No more than 32 characters Yes
card_no String URI Access card number Yes

Request Example

POST	/v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/card/d9e2816da0f54**/unfreeze

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
sn String command record id,One command record id corresponds to one command set

Example of Result Object

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