Call Users

Last Updated on : 2023-06-15 05:24:50

A cloud development project requests this API operation after receiving a call event from a specified access control device. Then, users will receive a call from the access control device on the mobile app.

API address

POST: /v1.0/access-control/{device_id}/persons/actions/call

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	Required	Description
sn	String	true	The call event command ID.
type	Integer	true	The operation type.
target_address	String	true	The room number that is called.
person_id_list	List	true	The list of user IDs.

Return parameter

Parameter name	Type	Description
result	CalledUserResponse	The returned result.

Description of result

Parameter name	Type	Description
device_id	String	The device ID.

Request example

POST: /v1.0/access-control/6ce****/persons/actions/call

{
  "sn": "133****",
  "type": 1,
  "target_address": "01-01-01-01-01-01",
  "person_id_list": [
    "ay1563240766201z****",
    "ay1563240766Jw30****"
  ]
}

Return example

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

Error code

For more information, see error code.

Prev DocResident Calling

Next DocSmart Access Users Batch Operations