All Products
Search
Document Center

Intelligent Media Services:GetCustomizedVoiceJob

Last Updated:Dec 16, 2024

Queries the information about a human voice cloning job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetCustomizedVoiceJobget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the human voice cloning job.

****20b48fb04483915d4f2cd8ac****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

****63E8B7C7-4812-46AD-0FA56029AC86****
Dataobject

The data returned if the request was successful.

CustomizedVoiceJobobject

The information about the human voice cloning job.

JobIdstring

The ID of the human voice cloning job.

****571c704445f9a0ee011406c2****
VoiceIdstring

The voice ID.

xiaozhuan
Statusstring

The job state. Valid values:

  • Initialization
  • AudioDetecting
  • PreTraining
  • Training
  • Success
  • Fail
Fail
Messagestring

The status description.

Typestring

The type of the human voice cloning job. Valid values:

  • Basic
  • Standard
Standard
VoiceNamestring

The voice name.

Xiaozhuan
VoiceDescstring

The voice description.

This is an exclusive voice
Scenariostring

The scenario. Valid values:

  • story
  • interaction
  • navigation
story
Genderstring

The gender. Valid values:

  • female
  • male
female
CreateTimestring

The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2023-06-07T02:27:08Z
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Data": {
    "CustomizedVoiceJob": {
      "JobId": "****571c704445f9a0ee011406c2****",
      "VoiceId": "xiaozhuan",
      "Status": "Fail",
      "Message": "",
      "Type": "Standard",
      "VoiceName": "Xiaozhuan\n",
      "VoiceDesc": "This is an exclusive voice\n",
      "Scenario": "story",
      "Gender": "female",
      "CreateTime": "2023-06-07T02:27:08Z"
    }
  },
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-21The response structure of the API has changedView Change Details