修改文档查看规则 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

第三方应用开发

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

第三方应用开发服务端API 文档设置文档权限修改文档查看规则

修改文档查看规则

最后更新：2022/12/09

该接口用于修改文档查看规则。

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

请求包体

{
    "docid":"DOCID",
    "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,
    "update_co_auth_list":true,
    "co_auth_list":[
        {
            "departmentid":DEPARTMENTID1,
            "auth":1,
            "type":2
        }
    ]
}

参数说明

参数	类型	是否必须	说明
docid	string	是	操作的docid
enable_corp_internal	bool	否	是否允许企业内成员浏览文档, 有值则覆盖
corp_internal_auth	uint32	否	企业内成员主动查看文档后获得的权限类型 1:只读, 有值则覆盖
enable_corp_external	uint32	否	是否允许企业外成员浏览文档, 有值则覆盖
corp_external_auth	uint32	否	企业外成员主浏览文档后获得的权限类型 1:只读, 有值则覆盖
corp_internal_approve_only_by_admin	bool	否	企业内成员加入文档是否必须由管理员审批，enable_corp_internal为false时，只能为true，有值则覆盖。设置为true之前，文档需要有至少一个管理员。
corp_external_approve_only_by_admin	bool	否	企业外成员加入文档是否必须由管理员审批，enable_corp_external和ban_share_external均为false时，该参数只能为true，有值则覆盖。设置为true之前，文档需要有至少一个管理员。
ban_share_external	bool	否	是否允许企业外成员浏览, 有值则覆盖
update_co_auth_list	bool	否	是否更新文档查看权限的特定部门, true时更新特定部门列表
co_auth_list	object[]	否	需要更新文档查看权限特定部门时, 覆盖之前部门, 特别的: 列表为空则清空
departmentid	uint64	否	文档查看权限特定部门id
auth	uint32	否	文档特定部门权限 1:只读, 目前只支持只读权限
type	uint32	否	文档特定部门类型 2:部门, 目前只支持部门

权限说明

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

返回示例

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

参数说明

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明

获取文档权限信息

修改文档通知范围及权限

本节内容

修改文档查看规则