添加访客

添加访客

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/acs/v1/visitors
HTTP Method	POST
接口频率限制	5 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	acs:users 查看、更新智能门禁用户
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
user	user_external	是	访客信息
└ user_type	int	是	用户类型 示例值：11 可选值有： - 1: 员工 - 2: 部门 - 10: 全体员工 - 11: 访客
└ user_id	string	否	用户id 示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"
└ user_name	string	否	用户名称 示例值："张三"
└ phone_num	string	否	电话号码 示例值："1357890001"
└ department_id	string	否	部门id 示例值："od-f7d44ab733f7602f5cc5194735fd9aaf"

请求体示例

{
    "user": {
        "user_type": 11,
        "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
        "user_name": "张三",
        "phone_num": "1357890001",
        "department_id": "od-f7d44ab733f7602f5cc5194735fd9aaf"
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ visitor_id	string	访客的id

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "visitor_id": "6939433228970082568"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1490001	param is invalid	参数无效
400	1490203	phone num already exist	电话号码已重复