获取文档权限信息 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

服务端API

文档

设置文档权限

获取文档权限信息

最后更新：2024/05/30

该接口用于获取文档、表格、智能表格的查看规则、文档通知范围及权限、安全设置信息

请求方式：POST（HTTPS）
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/doc_get_auth?access_token=ACCESS_TOKEN

请求包体

{
	"docid":"DOCID"
}

参数说明

参数	类型	是否必须	说明
docid	string	是	文档id

权限说明

自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用（accesstoken如何获取？）
第三方应用需具有“文档”权限
代开发自建应用需具有“文档”权限
只能访问该应用创建的文档

返回示例

{
    "errcode":0,
    "errmsg":"ok",
    "access_rule":{
        "enable_corp_internal":true,
        "corp_internal_auth":1,
        "enable_corp_external":true,
        "corp_external_auth":1,
        "corp_internal_approve_only_by_admin":true,
        "corp_external_approve_only_by_admin":true,
        "ban_share_external":false
    },
    "secure_setting":{
        "enable_readonly_copy":false,
        "watermark":{
            "margin_type":2,
            "show_visitor_name":false,
            "show_text":false,
            "text":""
        },
        "enable_readonly_comment":false
    },
    "doc_member_list":[
        {
            "type":1,
            "userid":"USERID1",
            "auth":7
        },
        {
            "type":1,
            "tmp_external_userid":"TMP_EXTERNAL_USERID2",
            "auth":1
        }
    ],
    "co_auth_list":[
        {
            "type":2,
            "departmentid":1,
            "auth":1
        }
    ]
}

参数说明

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明
access_rule	object	文档的查看规则
enable_corp_internal	bool	是否允许企业内成员浏览文档
corp_internal_auth	uint32	企业内成员主动查看文档后获得的权限类型 1:只读 2:读写（目前仅智能表可设置为读写）
enable_corp_external	bool	是否允许企业外成员浏览文档
corp_external_auth	uint32	企业内成员主动查看文档后获得的权限类型 1:只读 2:读写（目前仅智能表可设置为读写）
corp_internal_approve_only_by_admin	bool	企业内成员浏览文档是否必须由管理员审批，enable_corp_internal为false时，只能为true
corp_external_approve_only_by_admin	bool	企业外成员浏览文档是否必须由管理员审批，enable_corp_external和ban_share_external均为false时，该参数只能为true
ban_share_external	bool	是否允许企业外成员浏览文档
enable_readonly_copy	bool	仅浏览权限的成员是否允许导出、复制、打印
watermark	object	文档水印设置
margin_type	uint32	水印密度 1:稀疏 2:紧密
show_visitor_name	bool	是否展示访问者名字
show_text	bool	是否展示水印文字
text	bytes	水印文字
doc_member_list	obj[]	文档通知范围及权限列表
type	uint32	文档通知范围成员种类 1:user, 只支持成员
userid	bytes	企业成员的userid
tmp_external_userid	string	外部用户临时id。同一个用户在不同的文档中返回的该id不一致。
auth	uint32	该文档通知范围成员的权限 1:只读 2:读写（目前仅智能表可设置为读写） 7:管理员
co_auth_list	object	文档查看权限特定部门列表，可以直接浏览文档
type	uint32	特定部门列表 2:部门, 目前只支持部门
departmentid	uint64	特定部门id
auth	uint32	权限类型 1:只读,2:读写（目前仅智能表可设置为读写）