获取文档权限信息

POST

https://qyapi.weixin.qq.com/cgi-bin/wedoc/doc_get_auth

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

权限说明

第三方应用需具有“文档”权限
代开发自建应用需具有“文档”权限
只能访问该应用创建的文档

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qyapi.weixin.qq.com/cgi-bin/wedoc/doc_get_auth' \
--header 'Content-Type: application/json' \
--data-raw '{
	"docid":"DOCID"
}'

响应示例

{
    "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": "DEPARTMENTID1",
            "auth": 1
        }
    ]
}

请求参数

Query 参数

access_token

string

可选

示例值:

ACCESS_TOKEN

Body 参数application/json

docid

string

文档id

必需

示例

返回响应

🟢200成功

application/json

Body

errcode

integer

错误码

必需

errmsg

string

错误码说明

必需

access_rule

object

文档的查看规则

必需

enable_corp_internal

boolean

必需

是否允许企业内成员浏览文档

corp_internal_auth

integer

必需

企业内成员主动查看文档后获得的权限类型 1:只读

enable_corp_external

boolean

必需

是否允许企业外成员浏览文档

corp_external_auth

integer

必需

企业内成员主动查看文档后获得的权限类型 1:只读

corp_internal_approve_only_by_admin

boolean

必需

企业内成员浏览文档是否必须由管理员审批，enable_corp_internal为false时，只能为true

corp_external_approve_only_by_admin

boolean

必需

企业外成员浏览文档是否必须由管理员审批，enable_corp_external和ban_share_external均为false时，该参数只能为true

ban_share_external

boolean

必需

是否允许企业外成员浏览文档

secure_setting

object

必需

enable_readonly_copy

boolean

必需

仅浏览权限的成员是否允许导出、复制、打印

watermark

object

文档水印设置

必需

enable_readonly_comment

boolean

必需

doc_member_list

array [object {4}]

必需

文档通知范围及权限列表

type

integer

必需

文档通知范围成员种类 1:user, 只支持成员

userid

string

可选

企业成员的userid

auth

integer

必需

该文档通知范围成员的权限 1:只读 7:管理员

tmp_external_userid

string

可选

外部用户临时id。同一个用户在不同的文档中返回的该id不一致。

co_auth_list

array [object {3}]

必需

文档查看权限特定部门列表，可以直接浏览文档

type

integer

可选

特定部门列表 2:部门, 目前只支持部门

departmentid

string

特定部门id

可选

auth

integer

可选

权限类型 1:只读, 目前只支持只读权限

修改于 2022-12-07 05:45:11

分享文档

修改文档查看规则