Halaman ini belum tersedia dalam bahasa lokal Anda. Kami berusaha keras untuk menambahkan lebih banyak versi bahasa. Terima kasih atas dukungan Anda.
Querying Voice Training Tasks
Function
Queries voice training tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/voice-training-manage/user/jobs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
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 |
create_until |
No |
String |
Filter the records whose creation time is not later than the entered time. |
create_since |
No |
String |
Filter the records whose creation time is not earlier than the entered time. |
state |
No |
String |
Task status. By default, all statuses are selected. Multiple statuses can be queried. Use commas (,) to separate them. For example, state=FAILED,WAITING. |
job_id |
No |
String |
Task ID. |
voice_name |
No |
String |
Voice name. |
tag |
No |
String |
Task tag. |
job_type |
No |
String |
Training type.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-App-UserId |
No |
String |
Third-party user ID, which does not allow Chinese characters. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of tasks that meet the query criteria. Value range: 0-2147483647 |
jobs |
Array of TrainingJobInfo objects |
Virtual avatar model training tasks. |
Parameter |
Type |
Description |
---|---|---|
job_type |
String |
Training type.
|
job_id |
String |
Task ID. |
app_user_id |
String |
User ID. |
voice_name |
String |
Timbre name. The name is used as the name of the timbre model asset in the asset library. |
sex |
String |
Gender.
|
language |
String |
Language. |
state |
String |
Task status.
|
reject_times |
Integer |
Number of times that the status occurs in the current task. Value range: 1-10 |
asset_id |
String |
ID of the timbre model in the asset library. This parameter is displayed when the task status is successful. |
job_failed_code |
String |
An error code is displayed when a task fails. |
job_failed_reason |
String |
The failure cause is displayed when a task fails. |
create_time |
Long |
Task creation time. Value range: 1-2147483647 |
lastupdate_time |
Long |
Time when the task status is updated. Value range: 1-2147483647 |
voice_authorization_url |
String |
Link to the user's authorization letter. |
create_type |
String |
Task creation mode.
|
tag |
String |
Task tag.
|
phone |
String |
Mobile phone number |
dhtms_job_id |
String |
Image modeling task ID |
batch_name |
String |
Batch Name |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/voice-training-manage/user/jobs
Example Responses
Status code: 200
The information is returned when the request succeeded.
{ "count" : 2147483647, "jobs" : [ { "job_type" : "BASIC", "job_id" : "abcdefg", "app_user_id" : "123qwe", "voice_name" : "Female voice", "sex" : "FEMALE", "language" : "CN", "state" : "WAITING", "asset_id" : "my_asset_id", "job_failed_code" : "MSS.00000000", "job_failed_reason" : "error reason", "create_time" : 2147483647, "lastupdate_time" : 2147483647, "voice_authorization_url" : "https://bucket/data", "create_type" : "PACKAGE", "tag" : "ECOMMERCE" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The information is returned when the request succeeded. |
400 |
Invalid parameter. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot