- What's New
- Service Overview
- Service Brochure
- Getting Started
-
User Guide
- Prerequisites
- Permissions Management
- Image Modeling
- Voice Modeling
- Video Production
- Livestreaming
- Asset Management
- Appendix
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Asset Management
- Virtual Avatar Video Production
-
Virtual Avatar Livestreaming
-
Intelligent Livestreaming Room Management
- Creating an Intelligent Livestreaming Room
- Querying Intelligent Livestreaming Rooms
- Querying Intelligent Livestreaming Script Details
- Updating Intelligent Livestreaming Room Information
- Deleting an Intelligent Livestreaming Room
- Creating an Interaction Rule Library for Live Rooms
- Querying Interaction Rule Libraries for Live Rooms
- Updating an Interaction Rule Library for Live Rooms
- Deleting an Interaction Rule Library for Live Rooms
-
Livestreaming Task Management
- Starting a Virtual Human Intelligent Livestreaming Task
- Querying Livestreaming Tasks of a Live Room
- Querying Virtual Human Intelligent Livestreaming Task Details
- Ending a Virtual Human Intelligent Livestreaming Task
- Controlling Virtual Human Intelligent Livestreaming
- Querying All Virtual Human Livestreaming Tasks of a Tenant
- Reporting Livestreaming Events
- Live Product Management
-
Intelligent Livestreaming Room Management
-
Image Modeling Management
- Creating a Virtual Avatar Model Training Task
- Querying Virtual Avatar Model Training Tasks
- Querying Details About a Virtual Avatar Model Training Task
- Deleting a Virtual Avatar Model Training Task
- Updating a Virtual Avatar Model Training Task
- Executing a Virtual Avatar Model Training Task as a Tenant
-
Voice Modeling Task Management
- Creating a Voice Training Task (Basic Edition)
- Creating a Voice Training Task (Advanced Edition)
- Creating a Voice Training Task (Premium Edition)
- Querying Voice Training Tasks
- Submitting a Voice Training Task
- Querying Voice Training Task Details
- Deleting a Voice Training Task
- Querying Task Operation Logs
- Obtaining the URL for Uploading a Voice File
- Obtaining the Review Result of a Voice Training Task
- Confirming the Online Recording Result
- Obtaining the Confirmed Online Recording Result
- TTS Management
- Appendix
- Change History
- ssdk
- FAQs
- Videos
- General Reference
Copied.
Response
Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
For example, if status code 201 is returned for calling the API used to create an IAM user, the request is successful.
Response Header
Similar to a request, a response also has a header, for example, Content-Type.
Figure 1 shows the response header fields for the API used to create an IAM user. The X-Subject-Token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.
(Optional) Response Body
The body of a response is often returned in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.
The following is part of the response body for the API used to create an IAM user.
{ "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } }
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
1 2 3 4 |
{ "error_msg": "The request message format is invalid.", "error_code": "IMG.0001" } |
In the response body, error_code is an error code, and error_msg provides information about the error.
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