调用GetOfficePreviewURL接口获取文档预览的URL和AccessToken。

注意事项

当前只有华东1（杭州）、华东2（上海）、华北2（北京）和华南1（深圳）地域支持此功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetOfficePreviewURL

操作接口名称，系统规定参数，固定取值为GetOfficePreviewURL。
Project String 是 immdoctest

项目名称。
SrcUri String 是 oss://bucket1/object

源数据的存储位置。
RegionId String 否 cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com，例如当RegionId为cn-hangzhou时，地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

SrcType String 否 pdf

源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。

当OSS对象没有后缀名时，可以设置此参数。

目前支持的文件类型有：

  • 演示文件：PPT、PPTX、PPTM、PPSX、PPSM、PPS、POTX、POTM、DPT、DPS
  • 表格文件：ET、XLS、XLT、XLSX、XLSM、XLTX、XLTM、CSV
  • 文字文件：DOC、DOCX、TXT、DOT、WPS、WPT、DOTX、DOCM、DOTM
  • PDF格式文件：PDF
WatermarkType Integer 否 1

水印类型。

  • 0：无水印
  • 1：文字水印
WatermarkValue String 否 imm

文字水印的文字。

当WatermarkType设置为1时，才能设置此参数。
WatermarkFillStyle String 否 rgba(192, 192, 192, 0.6)

文字水印的透明度，默认值为rgba(192, 192, 192, 0.6)。
WatermarkFont String 否 bold 20px Serif

文字水印的字体，默认值为bold 20px Serif。
WatermarkRotate Float 否 -0.7853982

文字水印的旋转度，默认值为-0.7853982，单位为弧度。
WatermarkHorizontal Integer 否 50

文字水印水平间距，默认值为50，单位为px。
WatermarkVertical Integer 否 100

文字水印垂直间距，默认值为100，单位为px。

返回数据

名称 类型 示例值 描述
AccessToken String f3a3ad0ae32a4c6fb90ed00218********

访问文档预览服务器的凭证。
AccessTokenExpiredTime String 2020-11-19T06:46:19.069Z

凭证的过期时间，有效时间为30分钟。
PreviewURL String https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1

文档预览地址。
RefreshToken String 1eb6535cdf8a4732a7d7183891********

凭证过期时使用RefeshToken刷新凭证。
RefreshTokenExpiredTime String 2020-11-20T06:16:19.069Z

刷新凭证的过期时间，有效时间为1天。
RequestId String 14580EF3-442A-4AA2-959C-1464DC255EEB

当次请求的Request ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetOfficePreviewURL
&Project=immdoctest
&SrcUri=oss://bucket1/object
&<公共请求参数>

正常返回示例

XML 格式 

<PreviewURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&amp;simple=1&amp;_w_tokentype=1</PreviewURL>
<RefreshToken>1eb6535cdf8a4732a7d7183891********</RefreshToken>
<RequestId>14580EF3-442A-4AA2-959C-1464DC255EEB</RequestId>
<AccessToken>f3a3ad0ae32a4c6fb90ed00218********</AccessToken>
<RefreshTokenExpiredTime>2020-11-20T06:16:19.069Z</RefreshTokenExpiredTime>
<AccessTokenExpiredTime>2020-11-19T06:46:19.069Z</AccessTokenExpiredTime>

JSON 格式 

{
    "PreviewURL": "https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&amp;simple=1&amp;_w_tokentype=1",
    "RefreshToken": "1eb6535cdf8a4732a7d7183891********",
    "RequestId": "14580EF3-442A-4AA2-959C-1464DC255EEB",
    "AccessToken": "f3a3ad0ae32a4c6fb90ed00218********",
    "RefreshTokenExpiredTime": "2020-11-20T06:16:19.069Z",
    "AccessTokenExpiredTime": "2020-11-19T06:46:19.069Z"
}