Question

openID 300

接口说明

本接口用于设置文档水印信息。水印分为两类：自定义文档水印和访客水印，可同时设置（详见参数描述）。

注意：此接口不支持收集表、流程图、思维导图类型文档设置水印。

设置访客水印后，若访客没有登录，则无法查看。

权限说明

本接口需要拥有以下任意一项权限：

• scope.drive.editable
• scope.drive.file.metadata

请求格式

描述	定义
Path	/openapi/drive/v2/files/{fileID}/watermark
Method	PATCH
Content-Type	application/x-www-form-urlencoded
Accept	application/json

请求头部

详见Headers。

请求参数

路径参数

参数名	类型	必选	描述
fileID	string	是	文档唯一标识，详见fileID

查询参数

无

请求体

参数名	类型	必选	描述
text	string	否	文档水印文本。默认为取消设置文字水印（不影响访客水印）
visitorMark	integer	是	是否设置访客水印。1：设置访客水印，2：取消设置访客水印
margin	string	是	水印显示类型。loose：宽松型，tight：密集型
hideFromOwner	integer	是	水印是否对文档所有者隐藏。1：隐藏，2：不隐藏

响应参数

请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述

请求包体

PATCH /openapi/drive/v2/files/300000000$AAAAAAAAAAAA/watermark HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Type: application/x-www-form-urlencoded
Content-Length: 52

text=test&margin=loose&hideFromOwner=2&visitorMark=1

示例

curl --location --request PATCH 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA/watermark' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'text=test' \
--data-urlencode 'margin=loose' \
--data-urlencode 'hideFromOwner=2' \
--data-urlencode 'visitorMark=1'

响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed'}

错误码

错误码	错误说明	排查建议
10313	Access-Token 为空	HTTP Header 里 Access-Token 校验失败，请参考示例中的携带方式，检查相应字段。详情请见Headers。
10303	Open-Id 错误	HTTP Header 里 Open-Id 与预期不符，可能的原因有： - Open-Id 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - Open-Id 与 Access-Token 不匹配，请检查 Header 内容和获取 Token 接口回包是否一致。
10302	Client-Id 错误	HTTP Header 里 Client-Id 与预期不符，可能的原因有： - Client-Id 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - Client-Id 与 Access-Token 不匹配，请检查 Header 内容和调用获取 Token 接口接口时参数中的 Client-Id 是否一致。
37019	Token 校验失败，错误或过期	检查位于 HTTP Header 中的 Access-Token 是否正确，获取 Token 的方式请查阅授权流程以及获取 Token 接口
10002	参数错误	检查 visitorMark、 margin、 hideFromOwner 参数是否属于上述枚举类型
10003	内部错误	检查路径参数 fileID 是否正确，详见fileID

查询更多业务返回码