Use RefreshWebofficeToken to refresh a document preview and editing token - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Refreshes a Weboffice access token. A Weboffice access token is valid for 30 minutes. After it expires, you can no longer access Weboffice. To continue accessing Weboffice, call this operation to refresh the Weboffice access token and obtain a new token that is also valid for 30 minutes.

Operation description

Make sure that you are familiar with the billing method and pricing of Intelligent Media Management (IMM) before you invoke this operation.

For billing details, refer to WebOffice billing.
The access token expires in 30 minutes. Open the preview before the access token expires. After the token expires, previewing is no longer available.
The refresh token expires in 1 day. Invoke the refresh operation before the refresh token expires. After the token expires, it becomes invalid.
The returned expiration time is in UTC, which is 8 hours behind UTC+8.

Note

The access token is used for actual preview session access. The refresh token simplifies the parameter settings required for refreshing tokens. You can use the refresh token to directly obtain a new token with the previously configured settings.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:RefreshWebofficeToken

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For information about how to obtain the project name, see Create a project.	test-project
AccessToken	string	Yes	The Weboffice access token. You can obtain the token by calling the GenerateWebofficeToken or RefreshWebofficeToken operation.	99d1b8b478b641c1b3372f5bd6********
RefreshToken	string	Yes	The Weboffice refresh token. You can obtain the token by calling the GenerateWebofficeToken or RefreshWebofficeToken operation.	a730ae0d7c6a487d87c661d199********
CredentialConfig	CredentialConfig	No	Leave this parameter empty unless you have special requirements. The China authorization configuration. This parameter is optional. For more information, see Use chained authorization to access resources of other entities.

Response elements

Element	Type	Description	Example
	object	The Weboffice access token.
RequestId	string	The request ID.	501339F9-4B70-0CE2-AB8C-866C********
RefreshToken	string	The Weboffice refresh token.	72a52ab3702a4123ab5594671a********
AccessToken	string	The Weboffice access token.	4996466c690a4902846ce00f96********
RefreshTokenExpiredTime	string	The expiration time of the refresh token. The refresh token expires in 1 day. Format: ISO 8601 UTC timestamp with millisecond precision.	2021-09-01T12:37:28.950065359Z
AccessTokenExpiredTime	string	The expiration time of the access token. The access token expires in 30 minutes. Format: ISO 8601 UTC timestamp with millisecond precision.	2021-08-31T13:07:28.950065359Z

Examples

Success response

JSON format

{
  "RequestId": "501339F9-4B70-0CE2-AB8C-866C********",
  "RefreshToken": "72a52ab3702a4123ab5594671a********",
  "AccessToken": "4996466c690a4902846ce00f96********",
  "RefreshTokenExpiredTime": "2021-09-01T12:37:28.950065359Z",
  "AccessTokenExpiredTime": "2021-08-31T13:07:28.950065359Z"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.