On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Intelligent Livestreaming Room Management/ Querying Intelligent Livestreaming Rooms

Querying Intelligent Livestreaming Rooms

Updated on 2025-02-10 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

Queries intelligent livestreaming rooms.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/smart-live-rooms

**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
room_name	No	String	Fuzzy search by livestreaming room name.
dh_id	No	String	Search by virtual human image ID.
model_name	No	String	Fuzzy search by image name.
live_state	No	String	Live room status. The status can be WAITING, PROCESSING, SUCCESS, FAILED, or CANCELED. NULL indicates that there is no livestreaming task. Multiple statuses can be queried. Use commas (,) to separate them.
start_time	No	String	Start time of the latest livestreaming task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
end_time	No	String	End time. The format complies with RFC 3339, for example, 2021-01-10T10:43:17Z.
room_type	No	String	Query by live room type. Options: NORMAL: general live room. The room always exists and can start and stop livestreaming at any time. TEMP: temporary live room. After a livestreaming task is complete, the live room is automatically cleared. TEMPLATE: live room template
template_own_type	No	String	Users can query information based on their own templates, templates shared with others, and public templates. Owned: templates owned by a user and not shared yet SHARED_TO_OHTERS: templates shared with others SHARED_FROM_OHTERS: templates shared by others Public: public templates

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

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 livestreaming rooms. Value range: 0-2147483647
smart_live_rooms	Array of SmartLiveRoomBaseInfo objects	Livestreaming room list.

**Table 6** SmartLiveRoomBaseInfo
Parameter	Type	Description
room_id	String	Livestreaming room ID.
project_id	String	Tenant ID
room_name	String	Livestreaming room name.
room_type	String	Options: NORMAL: general live room. The room always exists and can start and stop livestreaming at any time. TEMP: temporary live room. After a livestreaming task is complete, the live room is automatically cleared. TEMPLATE: live room template Default value: NORMAL
room_state	String	Live room status. ENABLE: The live room is available. DISABLE: The live room is unavailable. The cause is described in error_info. BLOCKED: The live room has been blocked. The cause is described in error_info.
view_mode	String	Landscape or portrait mode. Default value: VERTICAL LANDSCAPE: landscape VERTICAL: portrait Default value: VERTICAL
error_info	ErrorResponse object	Error messages of a virtual human live room.
shared_config	SharedConfig object	Template sharing information between live rooms. This parameter is specified only when the live room type is template.
room_description	String	Livestreaming room description.
cover_url	String	Livestreaming room thumbnail URL.
thumbnail	String	Live room thumbnail URL
model_infos	Array of ModelInfo objects	Virtual human model information.
create_time	String	Creation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
update_time	String	Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
last_job_start_time	String	Time when livestreaming starts. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
last_job_end_time	String	Time when livestreaming ends. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
last_job_status	String	Current livestreaming status. WAITING: The task is waiting for execution. PROCESSING: The task is being executed. SUCCEED: The task is completed. FAILED: The task failed. CANCELED: The task has been canceled. BLOCKED: The task has been frozen.
priv_data	String	Private data, which is entered by the user and then returned with the same content.

**Table 7** ErrorResponse
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

**Table 8** SharedConfig
Parameter	Type	Description
shared_type	String	Details: Sharing type. Constraints: This configuration applies only to templates. Options: PRIVATE: accessible only to the current tenant PUBLIC: accessible to all tenants. Currently, only system assets are accessible to all tenants. SHARED: accessible to specified tenants, who are specified by the owner. Default value: N/A
shared_state	String	Details: Sharing status. Constraints: This configuration applies only to templates whose shared_type is SHARED. Options: PUBLISHED: published. The template is available. DRAFT: draft. The template is being edited and can be viewed only by the owner. REVIEW: The template is being reviewed. The template cannot be edited and can be viewed only by the owner/reviewer. Default value: N/A
expire_time	String	Details: Time when the sharing expires. If this parameter is left blank, the sharing never expires. Constraints: This configuration applies only to templates whose shared_type is SHARED. The format complies with RFC 3339, for example, 20210110T08:43:17Z. Options: The value contains 0 to 20 characters. Default value: N/A
allowed_project_ids	Array of strings	Details: Tenants allowed to access the asset. Constraints: This configuration applies only to templates whose shared_type is SHARED. Options: A maximum of 100 tenants are allowed. Duplicate records will be ignored. Enter a project ID containing 1 to 64 characters. Default value: N/A

**Table 9** ModelInfo
Parameter	Type	Description
model_asset_id	String	Model asset ID, which can be queried from the asset library.
asset_name	String	Asset name.
backup_model_asset_ids	Array of strings	ID of the alternative virtual streamer asset (image asset only) during streamer rotation, which can be queried from the asset library.

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms

Example Responses

Status code: 200

Succeeded.

{
  "count" : 1,
  "smart_live_rooms" : [ {
    "room_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
    "room_name" : "The Legend of Nature",
    "room_description" : "Courseware",
    "create_time" : "2022-11-30T06:59:55Z",
    "update_time" : "2022-12-05T12:30:37Z"
  } ]
}

Status code: 400

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

Status code: 401

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

Status code: 500

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

Status Codes

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

Error Codes

See Error Codes.

Parent Topic: Intelligent Livestreaming Room Management

Previous topic: Creating an Intelligent Livestreaming Room

Next topic: Querying Intelligent Livestreaming Script Details

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot