查询公共设备新版SDK
更新于 2023-02-03
接口功能介绍
调用本接口查询可信设备的公共设备列表，具体如下图：
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 专属钉钉可信设备信息读写权限 | API Explorer |
| 第三方企业应用 | 暂不支持 | 专属钉钉可信设备信息读写权限 | 暂不支持 |
| 第三方个人应用 | 暂不支持 | 专属钉钉可信设备信息读写权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Query参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
platform | String | 否 | 系统：
|
startTime | Long | 否 | 注册或申请的开始时间，单位毫秒。 |
endTime | Long | 否 | 注册或申请截止时间，单位毫秒。 |
pageSize | Integer | 否 | 单页返回的数据条数。 说明
|
pageNumber | Integer | 否 | 页码。 |
title | String | 否 | 设备标题。 |
macAddress | String | 否 | 设备mac地址。 |
返回参数
名称 | 类型 | 描述 |
|---|---|---|
totalCnt | Long | 数据总数。 |
dataCnt | Integer | 当前页数据量。 |
data | Array | 设备列表。 |
gmtCreate | Long | 创建时间。 |
gmtModified | Long | 修改时间。 |
title | String | 设备标题。 |
macAddress | String | Mac地址。 |
platform | String | 系统：
|
deviceScopeType | Integer | 生效范围：
|
deviceStaffs | Array | 员工列表。 说明
仅生效范围是部分生效时有效。 |
userId | String | 员工id。 |
name | String | 员工姓名。 |
deviceDepts | Array | 部门列表。 说明
仅生效范围是部分生效时有效。 |
id | Long | 部门id。 |
name | String | 部门名称。 |
deviceRoles | Array | 角色列表。 说明
仅生效范围是部分生效时有效。 |
tagCode | String | 角色code。 |
name | String | 角色名称。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | param.illegal | 参数不合法 | 参数不合法，请确认分页参数是否正确。 |
500 | service.error | 系统错误 | 系统错误 |
