获取权限组信息

获取权限组信息

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
device_id	string	否	设备id 示例值：7296700518380863767
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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ rules	rule\[\]	设备权限组信息
└ id	string	权限组id
└ name	string	权限组名称
└ devices	device_external\[\]	权限组包含的设备
└ id	string	设备id
└ name	string	设备名称
└ user_count	string	权限组包含的员工个数
└ users	user_external\[\]	权限组包含的员工列表
└ user_type	int	用户类型 可选值有： - 1: 员工 - 2: 部门 - 10: 全体员工 - 11: 访客
└ user_id	string	用户id
└ user_name	string	用户名称
└ phone_num	string	电话号码
└ department_id	string	部门id
└ visitor_count	string	权限组包含的访客个数
└ visitors	user_external\[\]	权限组包含的访客列表
└ user_type	int	用户类型 可选值有： - 1: 员工 - 2: 部门 - 10: 全体员工 - 11: 访客
└ user_id	string	用户id
└ user_name	string	用户名称
└ phone_num	string	电话号码
└ department_id	string	部门id
└ remind_face	boolean	是否通知人员录入
└ opening_time	opening_time_external	开门时间段
└ valid_day	opening_time_valid_day_external	有效日期
└ start_day	int	权限开始时间
└ end_day	int	权限结束时间
└ weekdays	int\[\]	有效星期
└ day_times	opening_time_period_external\[\]	有效时间
└ start_hhmm	int	起始时间
└ end_hhmm	int	结束时间
└ is_temp	boolean	是否为临时权限组

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "rules": [
            {
                "id": "34252345234523",
                "name": "南门",
                "devices": [
                    {
                        "id": "534545234523452345",
                        "name": "北门"
                    }
                ],
                "user_count": "3",
                "users": [
                    {
                        "user_type": 1,
                        "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
                        "user_name": "张三",
                        "phone_num": "1357890001",
                        "department_id": "od-f7d44ab733f7602f5cc5194735fd9aaf"
                    }
                ],
                "visitor_count": "3",
                "visitors": [
                    {
                        "user_type": 1,
                        "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
                        "user_name": "张三",
                        "phone_num": "1357890001",
                        "department_id": "od-f7d44ab733f7602f5cc5194735fd9aaf"
                    }
                ],
                "remind_face": false,
                "opening_time": {
                    "valid_day": {
                        "start_day": 1699031483,
                        "end_day": 1699931483
                    },
                    "weekdays": [
                        1,
                        2,
                        3
                    ],
                    "day_times": [
                        {
                            "start_hhmm": 1200,
                            "end_hhmm": 1400
                        }
                    ]
                },
                "is_temp": false
            }
        ]
    }
}