Help Center/ MetaStudio/ API Reference/ Asset Management/ Digital Asset Management/ Asset Transfer Tasks
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Asset Transfer Tasks

Function

Asset transfer tasks.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/digital-assets-action/transfers

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

role

No

String

Role, which can be SENDER, RECEIVER, and ALL.

Default value:

RECEIVER

state

No

String

Task status. Use commas (,) to separate multiple statuses.

  • PROCESSING: The task is being processed.

  • ACCEPT: The task is accepted.

  • REJECT: The task is rejected.

  • CANCEL: The task is cancelled.

  • FAIL: The task fails.

Default value:

PROCESSING

transfer_type

No

String

Task type. Tasks of the TRANSFER_OUT type are queried by default.

  • TRANSFER_OUT: transferring an asset

  • TRANSFER_BACK: transferring an asset back

Default value:

TRANSFER_OUT

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID
Table 5 Response body parameters

Parameter

Type

Description

count

Integer

Total number of tasks.

Value range:

0~200

jobs

Array of TransferAssetJobInfo objects

Task information
Table 6 TransferAssetJobInfo

Parameter

Type

Description

job_id

String

Asset transfer task ID

transfer_type

String

Definition

Transfer type. The default value is TRANSFER_OUT.

Constraints

  • Only administrators or tenants whitelisted for asset transfer have the permission to transfer assets.

  • Common tenants have the permission to transfer received assets to the transfer initiator.

Range

  • TRANSFER_OUT: transferring an asset

  • TRANSFER_BACK: transferring an asset back

transfer_assets

Array of DigitalAssetSummary objects

Asset transfer tasks

state

String

Task statuses:

  • PROCESSING: The task is being processed.

  • ACCEPT: The task is accepted.

  • REJECT: The task is rejected.

  • CANCEL: The task is cancelled.

  • FAIL: The task fails.

src_project_id

String

Source user ID

dest_project_id

String

Target user ID

memo

String

Remarks

reason

String

Freezing/Unfreezing reason

start_time

String

Asset transfer start time

finish_time

String

Asset transfer completion time

expire_time

String

Asset transfer expiration time

is_need_billing

Boolean

Whether to deduct resources from the recipient during asset transfer (generating charging CDRs)

Default value:

false

error_info

ErrorResponse object

Error message
Table 7 DigitalAssetSummary

Parameter

Type

Description

asset_id

String

Asset ID.

asset_name

String

Asset name.

asset_state

String

Asset status.

  • CREATING: The asset is being created. The main file has not been uploaded.

  • FAILED: Main file upload failed.

  • UNACTIVED: The main file has been uploaded. The asset is not activated and cannot be used for other services. (Users can update the status.)

  • ACTIVED: The main file has been uploaded. The asset is activated and can be used for other services. (Users can update the status.)

  • DELETING: The asset is being deleted. The asset is unavailable but can be restored.

  • DELETED: The asset has been deleted. The asset is unavailable and cannot be restored.

  • BLOCK: The asset has been frozen. The asset is unavailable and cannot be viewed.

  • WAITING_DELETE: The asset will be taken offline.

asset_type

String

Asset type.

Public asset type. Options:

  • VOICE_MODEL: timbre model (uploaded only by the system administrator. Common tenants can only query it.)

  • VIDEO: video file

  • IMAGE: image file

  • PPT: PowerPoint file

  • MUSIC: music

  • AUDIO: audio

  • COMMON_FILE: common file

Virtual avatar asset. Options:

  • HUMAN_MODEL_2D: virtual avatar model

  • BUSINESS_CARD_TEMPLATE: virtual avatar business card template

block_reason_code

String

Reason number for freezing.

cover_url

String

Path of the cover image.

thumbnail_url

String

Thumbnail path.
Table 8 ErrorResponse

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets/transfers

Example Responses

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Succeeded

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Digital Asset Management