# 拉取访客预约记录列表
查询所有预约访客记录。
# 1. 接口地址
# 请求方法:
POST(application/json)
# 请求地址:
https://open.wecard.qq.com/app-visit/open/get-appt-list?access_token=ACCESS_TOKEN&created_at_min=CREATED_AT_MIN&created_at_max=CREATED_AT_MAX&page=PAGE
注:若私有化部署,接口地址域名变更私有化域名
# 2. 请求参数
# 参数说明:
参数 | 必填 | 示例值 | 类型 | 说明 |
---|---|---|---|---|
access_token | 是 | k3yCoY5VYHWyVhgUPud2mtfOFvRvossc | string | 授权有效凭证 (opens new window) |
created_at_min | 否 | 1597593600 | string | 预约申请时间(区间起始) |
created_at_max | 否 | 1597680000 | string | 预约申请时间(区间终止) |
page | 否 | 1 | string | 页码 |
# 3. 返回数据
# 响应说明
{
"code": 0,
"message": "ok",
"list": [
{
"visitor_name": "访客001",
"visitor_phone": "(+86)13012345678",
"reason": "参观",
"status": 2,
"status_with_time": -100,
"card_number": "staff",
"visited_at": null,
"id_card_img": "",
"created_time": 1597662000,
"extra_fields": {
"证件号": "100100100100100100",
"同行人数": "1"
},
"visit_start_time": 1597766400,
"visit_end_time": 1597852800,
"member_name": "员工",
"member_phone": "(+86)18876543210",
"member_org": "部门"
}
],
"total": 88,
"limit": 20
}
参数 | 说明 |
---|---|
errcode | 返回码(0 表示成功) |
errmsg | 提示信息 |
list[] | 预约记录列表 |
list[].visitor_card_number | 访客电子卡号/学工号 |
list[].visitor_name | 访客姓名 |
list[].visitor_phone | 访客手机号 |
list[].card_number | 受访人电子卡号/学工号 |
list[].member_name | 受访人姓名 |
list[].member_phone | 受访人手机号 |
list[].member_org | 受访人所在部门 |
list[].reason | 到访事由 |
list[].status_with_time | 状态 |
list[].id_card_img | 补充证件图片 |
list[].extra_fields | 扩展表单字段 (json) |
list[].visit_start_time | 预约起始时间 |
list[].visit_end_time | 预约结束时间 |
list[].created_time | 预约申请时间 |
list[].visited_at | 到访时间 |
total | 匹配条目数 |
limit | 单页最多返回条目数 |
# status_with_time 含义
参数 | 说明 |
---|---|
1 | 待到访 |
2 | 已到访 |
-1 | 已取消 |
-2 | 已拒绝 |
-100 | 已过期 |
-101 | 未审核 (已过期) |
102 | 已签到 |
-102 | 已签离 |
# 注意事项
- 私有化部署的主体不能使用上面接口地址,需要根据主体私有化部署域名拼上对应的路径,主体私有化网关域名(私有化部署域名+/kong)