企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
安全管理
设备管理
设备管理
最后更新:2024/04/25

目录

  • 权限说明
  • 导入可信企业设备
  • 获取设备信息
  • 获取成员使用设备
  • 删除设备信息
  • 确认为可信设备
  • 驳回可信设备申请
  • 启用了 “设备管理”的企业可以通过相关接口导入可信企业设备,获取/删除可信企业设备、可信个人设备、未知设备,并对未知设备的归属申请进行确认或驳回。

    权限说明

    调用设备管理相关接口的应用需要满足如下的权限:

    应用类型权限要求
    自建应用配置到「安全与管理 - 设备管理 - 可调用接口的应用」中
    代开发应用暂不支持
    第三方应用暂不支持

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

    导入可信企业设备

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/import?access_token=ACCESS_TOKEN

    请求包体

    {
    	"device_list":
    	[
    		{
    			"system":"Windows",
    			"mac_addr":
    			[
    				"50:81:40:29:33:CA",
    				"36:27:51:DF:6E:80"
    			],
    			"motherboard_uuid":"MB_UUID",
    			"harddisk_uuid":
    			[
    				"HD_UUID1",
    				"HD_UUID2"
    			],
    			"domain":"WINDOWS_DOMAIN",
    			"pc_name":"PC_001",
    		},
    		{
    			"system":"Mac",
    			"seq_no":"SEQ_NO",
    			"mac_addr":
    			[
    				"81:40:50:29:33:DB"
    			]
    		}
    	]
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    device_list.systemstring设备的类型,WindowsMac
    device_list.mac_addrstring设备MAC地址,当system为Windows时必填,Mac选填,每个设备最多100个
    device_list.motherboard_uuidstring主板UUID,当system为Windows可选填此参数
    device_list.harddisk_uuidstring硬盘序列号,当system为Windows时可选填此参数,每个设备最多100个
    device_list.domainstringWindows域名,当system为Windows时可选填此参数
    device_list.pc_namestringWindows计算机名,当system为Windows时可选填此参数
    device_list.seq_nostringMac序列号,当system为Mac时必填

    调用说明

    • 每次调用最多导入100条可信企业设备记录

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"result":
    	[
    		{
    		   "device_index":1,
    		   "device_code":"49nNtYq",
    			"status":1
    		},
    		{
    			"device_index":2,
    			"duplicated_device_code":"49nNtYq",
    			"status":2
    		},
    		{
    			"device_index":3,
    			"status":3
    		}
    	]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    result.device_indexint32导入设备记录的标识,对应请求中设备的顺序,从1开始
    result.device_codestring设备的唯一标识,仅导入成功的记录返回
    result.duplicated_device_codestring当重复导入(status=2)时,与当前导入记录冲突的设备的device_code
    result.statusint32导入结果,1-成功 2-重复导入 3-不支持的设备 4-数据格式错误

     

    获取设备信息

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/list?access_token=ACCESS_TOKEN

    请求包体

    {
    	"cursor":"CURSOR",
    	"limit":100,
    	"type":1
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    cursorstring分页cursor,用于获取分页数据
    typeint32查询设备类型,1-可信企业设备 2-未知设备 3-可信个人设备
    limitint32查询返回的最大记录数,最高不超过100,默认为100

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"device_list":
    	[
    		{
    			"device_code":"49nNtYq",
    			"system":"Windows",
    			"mac_addr":
    			[
    				"50:81:40:29:33:CA"
    			],
    			"motherboard_uuid":"MB_UUID",
    			"harddisk_uuid":
    			[
    				"HD_UUID1"
    			],
    			"domain":"WINDOWS_DOMAIN",
    			"pc_name":"PC_001",
    			"last_login_time":1681722163,
    			"last_login_userid":"lisi",
    			"confirm_timestamp":1681722163,
    			"confirm_userid":"lisi",
    			"approved_userid":"zhangsan",
    			"source":3,
    			"status":5
    		},
    		{
    			"device_code":"rjDTnOh",
    			"system":"Mac",
    			"seq_no":"SEQ_NO1",
    			"mac_addr":
    			[
    				"50:81:40:29:33:CA"
    			],
    			"source":1,
    			"status":5
    		}
    	],
    	"next_cursor":"CURSOR"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    device.device_codestring设备编码
    device_list.systemstring设备的类型,WindowsMac
    device_list.mac_addrstring设备MAC地址
    device_list.motherboard_uuidstring主板UUID
    device_list.harddisk_uuidstring硬盘UUID
    device_list.domainstringWindows域
    device_list.pc_namestring计算机名
    device_list.seq_nostringMac序列号
    device_list.last_login_timeint32设备最后登录时间戳
    device_list.last_login_useridstring设备最后登录成员userid
    device_list.confirm_timestampint32设备归属/确认时间戳
    device_list.confirm_useridstring设备归属/确认成员userid
    device_list.approved_useridstring通过申报的管理员userid
    device_list.sourceint32设备来源 0-未知 1-成员确认 2-管理员导入 3-成员自主申报
    device_list.statusint32设备状态 1-已导入未登录 2-待邀请 3-待管理员确认为企业设备 4-待管理员确认为个人设备 5-已确认为可信企业设备 6-已确认为可信个人设备
    next_cursorstring分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空
    注意,当获取未确认为可信企业设备的记录时,即获取status为2、4、6时,mac地址,序列号,主板UUID等将会返回脱敏数据。

    获取成员使用设备

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/get_by_user?access_token=ACCESS_TOKEN

    请求包体

    {
    	"last_login_userid":"zhangsan",
    	"type":1
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    last_login_useridstring最后登录的成员userid
    typeint32查询设备类型,1-可信企业设备 2-未知设备 3-可信个人设备

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"device_list":
    	[
    		{
    			"device_code":"49nNtYq",
    			"system":"Windows",
    			"mac_addr":
    			[
    				"50:81:40:29:33:CA"
    			],
    			"motherboard_uuid":"MB_UUID",
    			"harddisk_uuid":
    			[
    				"HD_UUID1"
    			],
    			"domain":"WINDOWS_DOMAIN",
    			"pc_name":"PC_001",
    			"last_login_time":1681722163,
    			"last_login_userid":"lisi",
    			"confirm_timestamp":1681722163,
    			"confirm_userid":"lisi",
    			"approved_userid":"zhangsan",
    			"source":3,
    			"status":5
    		},
    		{
    			"device_code":"rjDTnOh",
    			"system":"Mac",
    			"seq_no":"SEQ_NO1",
    			"mac_addr":
    			[
    				"50:81:40:29:33:CA"
    			],
    			"source":1,
    			"status":5
    		}
    	]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    device_list.device_codestring设备编码
    device_list.systemstring设备的类型,WindowsMac
    device_list.mac_addrstring设备MAC地址
    device_list.motherboard_uuidstring主板UUID
    device_list.harddisk_uuidstring硬盘UUID
    device_list.domainstringwindows域
    device_list.pc_namestring计算机名
    device_list.seq_nostringMac序列号
    device_list.last_login_timeint32设备最后登录时间戳
    device_list.last_login_useridstring设备最后登录成员userid
    device_list.confirm_timestampint32设备归属/确认时间戳
    device_list.confirm_useridstring设备归属/确认成员userid
    device_list.approved_useridstring通过申报的管理员userid
    device_list.sourceint32设备来源 0-未知 1-成员确认 2-管理员导入 3-成员自主申报
    device_list.statusint32设备状态 1-已导入未登录 2-待邀请 3-待管理员确认为企业设备 4-待管理员确认未个人设备 5-已确认为可信企业设备 6-已确认为可信个人设备
    注意,当获取未确认为可信企业设备的记录时,即获取status为2、4、6时,mac地址,序列号,主板UUID等将会返回脱敏数据。

     

    删除设备信息

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/delete?access_token=ACCESS_TOKEN

    请求包体

    {
    	"type":1,
    	"device_code_list":
    	[
    		"49nNtYq",
    		"rjDTnOh"
    	]
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    typeint32删除设备类型,1-可信企业设备 2-未知设备 3-可信个人设备
    device_code_liststring设备编码列表

     

    调用说明

    • 每次调用可删除100个设备

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明

     

    确认为可信设备

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/approve?access_token=ACCESS_TOKEN

    请求包体

    {
    	"device_code_list":
    	[
    		"49nNtYq",
    		"rjDTnOh"
    	]
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    device_code_liststring设备编码列表, 仅可确认待管理员通过状态,即status为3或4的设备

     

    调用说明

    • 每次调用最多可以确认100个设备

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"success_list":["49nNtYq"],
    	"fail_list":["rjDTnOh"]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    success_liststring确认成功设备code列表
    fail_liststring确认失败设备code列表

    驳回可信设备申请

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/security/trustdevice/reject?access_token=ACCESS_TOKEN

    请求包体

    {
    	"device_code_list":
    	[
    		"49nNtYq",
    		"rjDTnOh"
    	]
    }

    参数说明

    参数类型是否必须说明
    access_tokenstring应用调用凭证
    device_code_liststring设备编码列表,仅可驳回待管理员通过状态,即status为3或4的设备

     

    调用说明

    • 每次调用最多可以拒绝100个设备

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"success_list":["49nNtYq"],
    	"fail_list":["rjDTnOh"]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    success_liststring驳回成功设备code列表
    fail_liststring驳回失败设备code列表
    上一篇文件防泄漏
    下一篇截屏/录屏管理
      本节内容
    服务端API
    基础
    连接微信
    办公
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    WECOM-JSSDK
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们