API列表
| 请求方式 |
API |
描述 |
| POST |
/v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/actions/open |
远程开门 |
| POST |
/v1.0/iot-02/third/doors/{device_id}/persons/actions/call |
呼叫住户,支持同时呼叫多个住户 |
远程开门
功能描述
用于在远程通过app进行开门。
接口地址
POST /v1.0/iot-02/third/doors/{device_id}/persons/{person_id}/actions/open
请求参数
| 请求参数 |
类型 |
参数类型 |
描述 |
是否必传 |
| device_id |
String |
URI |
涂鸦设备id |
是 |
| person_id |
String |
URI |
涂鸦用户id,不超过32个字符 |
是 |
请求示例
POST /v1.0/iot-02/third/doors/002dj00118fe34d9****/persons/162627/actions/open
返回信息
| 参数名 |
类型 |
说明 |
| code |
Integer |
响应码(详情见错误码章节) |
| success |
Boolean |
本次请求是否成功:(true:成功,false:失败) |
| msg |
String |
请求失败的信息,成功为空 |
| result |
Object |
返回结果 |
result 说明
| 参数名 |
类型 |
说明 |
| sn |
String |
指令记录id,一个指令记录id对应一个指令集 |
返回结果示例
{
"success": true,
"t": 1561456817168,
"result": {
"sn":"1212581947449081****"
}
}
呼叫住户
功能描述
用户在可视门禁上呼叫业主。合作方收到呼叫事件后, 根据房间号查询业主列表, 并把业主列表通过该接口提供给涂鸦, 由涂鸦对住户app发起呼叫或挂断。目前最多支持同时呼叫3个住户。
接口地址
POST /v1.0/iot-02/third/doors/{device_id}/persons/actions/call
请求参数
| 请求参数 |
类型 |
参数类型 |
描述 |
是否必传 |
| device_id |
String |
URI |
涂鸦设备id |
是 |
| sn |
String |
BODY |
sn号, 长度不超过20个字符 |
是 |
| type |
Integer |
BODY |
操作类型, 参考呼叫事件 |
是 |
| target_address |
String |
BODY |
被呼叫房间号, 参考呼叫事件 |
否 |
| person_id_list |
List |
BODY |
被呼叫涂鸦用户id列表, 用户id长度不超过32个字符 |
是 |
请求示例
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****"]
}
返回信息
| 参数名 |
类型 |
说明 |
| code |
Integer |
响应码(详情见错误码章节) |
| success |
Boolean |
本次请求是否成功:(true:成功,false:失败) |
| msg |
String |
请求失败的信息,成功为空 |
| result |
Object |
返回结果 |
result 说明
| 参数名 |
类型 |
说明 |
| device_id |
String |
涂鸦设备id |
返回结果示例
{
"success": true,
"t": 1561456817168,
"result": {
"device_id":"002dj00118fe34d9****"
}
}