# 通行名单
# 接口说明
| host | path | method | content-type |
|---|---|---|---|
| open.wecard.qq.com | /cgi-bin/guard/device/pass-list | POST | application/json |
# 请求参数
{
"access_token": "z8WH...R7Fd",
"device_no": "MRC00001",
"with_rule": true,
"page": 1,
"page_size": 20
}
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
access_token | ✔️ | string | 接口请求凭证 |
device_no | ✔️ | string | 门禁机具设备号 |
with_rule | bool | 返回是否附带通行规则 | |
page | int | 分页页数(从 1 开始) | |
page_size | int | 分页每页记录条数 |
# 响应参数
{
"code": 0,
"message": "",
"data": {
"open": true,
"page": 1,
"page_size": 20,
"total": 0,
"version": 4
}
}
{
"code": 0,
"message": "",
"data": {
"users": [
{
"c": "12345678",
"p": "7h5g0123",
"r": ["3tx"]
}
],
"rules": [
{
"mark": "3tx",
"configs": [
{
"time_ranges": [
{
"start": "00:00:00",
"end": "23:59:59"
}
]
}
]
}
],
"page": 1,
"page_size": 20,
"total": 1,
"version": 4
}
}
# data 中的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
open | bool | 是否开放通行,当open为true时,users和rules将不返回 |
users | array | 通行名单,见下方说明 |
rules | array | 通行规则,请求参数with_rule为true时返回,见通行规则说明 |
page | int | 分页页数,根据请求参数确定 |
page_size | int | 分页每页记录条数,根据请求参数确定 |
total | int | 总记录条数 |
version | int | 对应名单规则版本号 |
# 通行名单说明
{
"c": "12345678",
"p": "7h5g0123",
"r": ["3tx"]
}
| 参数 | 类型 | 说明 |
|---|---|---|
c | string | 电子卡号 |
p | string | 实体卡号 |
r | array | 对应的通行规则的mark字段的列表,满足列表中任意mark对应的规则即视为通过时间核验 |