获取设备信息
使用该接口在设备管理中获取设备的设备参数、设备归属、设备状态等信息
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/security_and_compliance/v2/device_records/:device_record_id |
| HTTP Method | GET |
| 接口频率限制 | 50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | security_and_compliance:device_record:read 获取设备信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
device_record_id | string | 设备认证编码,通过调用查询设备信息接口获取 示例值:"7089353870308032531" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
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 | \- | - |
└ device_record | device_record | 设备记录 |
└ device_record_id | string | 设备认证编码 |
└ version | string | 版本号 |
└ current_user_id | string | 当前登录用户ID |
└ device_name | string | 设备名称 |
└ model | string | 设备型号 |
└ device_system | int | 操作系统 可选值有: - 1: Windows - 2: macOS - 3: Linux - 4: Android - 5: iOS - 6: OpenHarmony |
└ serial_number | string | 生产序列号 |
└ disk_serial_number | string | 硬盘序列号 |
└ uuid | string | 主板UUID |
└ mac_address | string | MAC地址 |
└ android_id | string | Android标识符 |
└ idfv | string | iOS供应商标识符 |
└ aaid | string | Harmony供应商标识符 |
└ device_ownership | int | 设备归属 可选值有: - 0: 未知设备 - 1: 个人设备 - 2: 企业设备 |
└ device_status | int | 可信状态 可选值有: - 0: 未知状态 - 1: 信任设备 - 2: 非信任设备 |
└ certification_level | int | 认证方式 可选值有: - 0: 未知 - 1: 飞书认证 - 2: 终端管理认证 |
└ device_terminal_type | int | 设备类型 可选值有: - 0: 未知 - 1: 移动端 - 2: 桌面端 |
└ latest_user_id | string | 最近登录用户ID |
└ dids | string\[\] | 设备指纹列表 |
└ is_managed | boolean | 是否为受管控设备 |
└ mdm_device_id | string | MDM设备ID |
└ mdm_provider_name | string | MDM厂商名称 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"device_record": {
"device_record_id": "7089353870308032531",
"version": "0",
"current_user_id": "ou_b25e90585ef8c1adac4b379c2e257906",
"device_name": "Q9C6RYMFDK",
"model": "iPhone13,2",
"device_system": 0,
"serial_number": "C02DTHRMML7H",
"disk_serial_number": "CC344362-5990-5A68-8DDD-64A23C99FA0C",
"uuid": "621CDFF0-13D0-5AB1-9ADC-5F560095F6ED",
"mac_address": "ac:de:48:00:11:21",
"android_id": "02a11ac4a83b918e",
"idfv": "968F0E5C-C297-4122-ACB6-102494DEFD9A",
"aaid": "ff3c2237-cd76-4331-9d72-0a4470854567",
"device_ownership": 0,
"device_status": 0,
"certification_level": 0,
"device_terminal_type": 0,
"latest_user_id": "ou_b25e90585ef8c1adac4b379c2e257906",
"dids": [
"7089353870308032531"
],
"is_managed": true,
"mdm_device_id": "123abc",
"mdm_provider_name": "Workspace_ONE"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1780001 | Internal server error. | 内部接口处理失败。若无法解决请寻求客服帮:https://applink.larkoffice.com/TLJpeNdW |
| 400 | 1780101 | Request param error. | 检查参数是否正确。若无法解决请寻求客服帮:https://applink.larkoffice.com/TLJpeNdW |
| 400 | 1780102 | The API is in beta testing. Please contact customer support to request beta access. | 联系服务提供方排查:https://applink.larkoffice.com/TLJpeNdW |
| 400 | 1785008 | The device is not found. Please check the parameter device_record_id. | 检查参数中设备编码是否存在 |
