Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Intelligent Livestreaming Room Management/ Querying Risk Information in a Live Room
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Risk Information in a Live Room

Function

Queries risk information in a live room.

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

GET /v1/{project_id}/smart-live-rooms/{room_id}/live-warning-info

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.

room_id

Yes

String

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

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 4 Response body parameters

Parameter

Type

Description

live_warning_info

Array of LiveWarningItem objects

List of livestreaming risk alarms.

limit_duration

Integer

Definition:

Maximum livestreaming duration, in hours.

The value 0 indicates no limit.

Constraints:

If the condition for stopping a livestream is set to stopping immediately, the livestream will continue running for a maximum of five minutes after an error occurs. For other conditions, the processing duration needs to be included.

Default value:

If this parameter is not specified, the duration is not limited.

Value range:

0~168
Table 5 LiveWarningItem

Parameter

Type

Description

warning_type

String

Alarm type.

  • TOO_LESSS_SCRIPT_ITEMS: There are too few paragraphs (scripts).

  • TOO_SHORT_SCRIPT_TIME: The total duration of paragraphs (scripts) is too short.

  • TOO_LESS_DANMAKU_RULES: There are too few on-screen comment interaction rules.

  • RANDOM_PLAY_CLOSED: The random playback function is disabled.

  • ROTATION_MODEL_CLOSED: Streamer rotation is not configured.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 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/24bad716-87b1-45e5-8912-6102f7693265/live-warning-info

Example Responses

Status code: 200

Succeeded.

{
  "live_warning_info" : [ {
    "warning_type" : "TOO_LESSS_SCRIPT_ITEMS"
  } ]
}

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

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