GenerateWebofficeToken

• Before you use this operation, make sure that you are familiar with the billing of Intelligent Media Management. For more information, see Pricing.

• Do not perform cross-border access on OSS files. For example, if a file is stored in a bucket in the Singapore region, do not initiate preview, read, or download requests from the Chinese mainland. In such scenarios, the network link quality is significantly affected by the cross-border network environment, which may cause increased access latency, preview failures, download interruptions, or unstable connections. Network stability and access experience cannot be guaranteed. Make sure that the access point and the bucket are in the same region to avoid uncertainties caused by cross-border access.

• The access credential expires in 30 minutes, and the refresh credential expires in 1 day.

• The returned expiration time is in UTC, which is 8 hours behind UTC+8.

• Supported input file formats:

  • Word documents: doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, and rtf.

  • Presentation documents (PPT): ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, and dps.

  • Excel documents: et, xls, xlt, xlsx, xlsm, xltx, xltm, and csv.

  • PDF documents: pdf.

• The maximum supported file size is 200 MB.

• The maximum supported number of document pages is 5,000.

• For projects created before December 1, 2023, billing is based on the number of document opens. Currently, billing is based on the number of API calls. To switch to the new billing mode, create a new project. Note that each API call can be used by only one user. If the call is reused, only the last user can access the document normally, and the access permissions of other users are revoked.

• Activate Message Service (MNS) in the same region as Intelligent Media Management, create a topic and a queue, and configure a subscription. You can pass in the MNS topic name by using the NotifyTopicName parameter to receive message notifications about file saves. For more information about the MNS SDK, see Receive and delete messages. For an example of the JSON format of the Message field in file save message notifications, see WebOffice message notification format.

Typical scenario examples

The following examples describe some typical scenarios based on the parameter structure:

Preview a read-only file (required for previewing PDF files)

Document preview mode. The document can only be previewed and cannot be edited:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.pdf",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

Preview a file with an uppercase file name extension

To preview a file with an uppercase file name extension, set the Filename parameter with a lowercase extension:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.DOCX",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

Preview only the first 5 pages of a document

The document has 10 pages in total. Only the first 5 pages are displayed:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

Set a password for document preview

Set a password for document preview, or directly open a password-protected source file without requiring a password:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Password" : "123456",
    "Permission" : "{'Readonly':'true'}"
}

Add a watermark to document preview

Add a watermark when previewing a document:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Watermark" : "{'Type':'1','Value':'水印值','Font':'bold 20px Serif'}",
    "Permission" : "{'Readonly':'true'}"
}

Hide the toolbar during document preview

Hide the toolbar when previewing a document:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Hidecmb" : "true",
    "Permission" : "{'Readonly':'true'}"
}

Edit a document online with permissions to view historical versions, copy, print, and export to PDF

Edit a document online with permissions to view historical versions, copy, print, and export to PDF:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Permission" : "{'Readonly':'false','History':'true','Copy':'true','Print':'true','Export':'true'}"
}
```.

Common errors.

The project specified by ProjectName is not found. Go to the IMM console and check whether the project exists in the region.

{
    "Code": "ResourceNotFound",
    "Message": "The specified resource acs:imm::xxx:project/xxx is not found"
}
```.

The User parameter is required. Check whether this parameter is specified.

{ "Code": "InvalidArgument.User", "Message": "The parameter User is required but not provided" }

The User parameter is invalid. Check whether the parameter value is in valid JSON format.

{ "Code": "InvalidJSON parsing error, User", "Message": "Specified parameter JSON parsing error, User is not valid." }

The Permission parameter is invalid. Check whether the parameter value is in valid JSON format.

{ "Code": "InvalidJSON parsing error, Permission", "Message": "Specified parameter JSON parsing error, Permission is not valid." }

The Watermark parameter is invalid. Check whether the parameter value is in valid JSON format.

{ "Code": "InvalidJSON parsing error, Watermark", "Message": "Specified parameter JSON parsing error, Watermark is not valid." }

The PreviewPages parameter format is invalid. Check the PreviewPages parameter value.

{ "Code": "InvalidPreviewPages", "Message": "Specified parameter PreviewPages is not valid." }

The OSS file specified by SourceURI does not exist. Check whether the file exists in the bucket.

{ "Code": "ResourceNotFound", "Message": "The specified resource oss://xx is not found" }