Intelligent Media Management:GenerateWebofficeToken

• Before you use this API, make sure that you fully understand the billing methods and pricing of Intelligent Media Management (IMM).

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

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

• Supported input file formats:

  • Word processing documents (Word): 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.

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

  • PDF documents: pdf.

• The maximum file size is 200 MB.

• The maximum number of pages is 5,000.

• For projects created before December 1, 2023, billing is based on the number of times a document is opened. For new projects, billing is based on the number of API calls. To switch to the new billing model, you must create a new project. Note that a single API call can be used by only one user. If the same API call is used by multiple users, only the last user can access the document, and the access permissions of other users are revoked.

• Activate Message Service (MNS) in the same region as IMM. Create a topic and a queue, and then configure a subscription relationship. You can then pass the MNS topic name in the NotifyTopicName parameter to receive notifications when a file is saved. For more information about the MNS software development kit (SDK), see Receive and delete messages. For an example of the JSON format of the Message field in a file save notification, see WebOffice notification message format.

Typical scenarios

The following examples show the parameter structure for each scenario.

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

To preview a document in read-only mode:

 {
    "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

To display only the first 5 pages of a 10-page document:

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

Add a password for document preview

To set a password for a document preview, or to open a password-protected source file for preview without a password prompt:

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

Add a watermark to a document preview

To add a watermark during a document preview:

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

Hide the toolbar during document preview

To hide the toolbar during a document preview:

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

Grant permissions to edit online, view history, copy, print, and export to PDF

To grant permissions to edit online, view history, 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 that corresponds to `ProjectName` was not found. Go to the new IMM console to check whether the project exists in the specified 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 the correct 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 the correct 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 the correct JSON format.

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

The format of the `PreviewPages` parameter is invalid. Check the value of this parameter.

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

The OSS file that corresponds to `SourceURI` does not exist. Check whether the file exists in the OSS bucket.

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