Creating a Virtual Avatar Video Subtitle File

Function

Creates a virtual avatar video subtitle file.

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

POST /v1/{project_id}/subtitle-files

**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.

Request Parameters

**Table 2** 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-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
script_id	No	String	Script ID.
sequence_no	No	Integer	Script No. NOTE: If the script sequence number is not specified, subtitles of all scenes are generated. To generate the subtitle of a single scene, enter the desired script sequence number. Value range: 0~2147483647
callback_config	No	CallBackConfig object	Callback settings. A callback is triggered after the subtitle file is generated.

**Table 4** CallBackConfig
Parameter	Mandatory	Type	Description
callback_url	Yes	String	Callback URL. The callback request body is in JSON format and contains the following parameters: result: SUCCEED or FAILED asset_id: asset ID job_id: task
auth_type	No	String	Authentication type. None. The URL contains authentication. MSS_A: In HMACSHA256 signature mode, the secret and time_stamp parameters are added to the URL. Value format: secret=hmac_sha256(key, URI (callback_url) + time_stamp)&time_stamp=hex(timestamp) Default value: NONE
key	No	String	Key.

Response Parameters

Status code: 200

**Table 5** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/subtitle-files

{
  "script_id" : "a5d295cdb345c11bd9f36bc22ced3a7a"
}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

Status code: 400

Parameters error, including the error code and its description.

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

Status code: 401

Authentication is not performed or fails.

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 500

Internal service error.

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	Returned when the request succeeded.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
500	Internal service error.