Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Livestreaming Task Management/ Controlling Virtual Human Intelligent Livestreaming
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Controlling Virtual Human Intelligent Livestreaming

Function

Controls virtual human intelligent livestreaming.

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

POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/command

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.

job_id

Yes

String

Task 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

command

Yes

String

Definition:

Command name.

Constraints:

None

Value range:

  • INSERT_PLAY_SCRIPT: inserts a script that is used for interactive reply. The virtual avatar and background remain unchanged. params structure definition: PlayTextInfo.

  • INSERT_PLAY_AUDIO: inserts an audio that is used to control a virtual avatar. The virtual avatar and background remain unchanged. params structure definition: PlayAudioInfo.

  • REWRITE_PLAY_SCRIPT: dynamically edits a script that has not been played. params structure definition: scene_scripts.

  • REWRITE_INTERACTION_RULES: dynamically modifies an interaction rule. params structure definition: interaction_rules.

  • GET_CURRENT_PLAYING_SCRIPTS: queries the script list of the current round. The response structure is LivePlayingScriptList.

  • SHOW_LAYER: displays materials used for livestreaming. params structure definition: LiveGuideRuleInfo.

  • REFRESH_OUTPUT_URL: updates the RTMP stream push information of the current task. params structure definition: RefreshOutputUrlConfig.

  • GET_LIVE_JOB_CONFIG_INFO: obtains room information in a task. The params structure definition is the same as that in the response body of live room details.

  • CLEAN_UP_INSERT_COMMAND: clears the insertion commands that are not played. params structure definition: CleanUpInsertCommand.

  • RESET_EXIT_CONFIG: resets exit parameters. params structure definition: LiveExitConfig. Example: {"command":"RESET_EXIT_CONFIG","params":{"max_live_duration":168,"auto_stop_mode":"FORCE_EXIT","max_exception_waiting_duration":60}}

Default value:

N/A

params

No

Object

Details:

Command parameter.

Constraints:

None

Options:

For details, see the COMMAND description.

Default value:

N/A

review_config

No

ReviewConfig object

Content review configuration.
Table 4 ReviewConfig

Parameter

Mandatory

Type

Description

no_need_review

No

Boolean

Content review whitelist. This feature is available only for users in the whitelist. The auto review policies apply to other users.

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 6 Response body parameters

Parameter

Type

Description

command_id

String

Control command ID

command

String

Command name.

  • INSERT_PLAY_SCRIPT: inserts a script that is used for interactive reply. The virtual avatar and background remain unchanged. params structure definition: ShootScript.

  • REWRITE_PLAY_SCRIPT: dynamically edits a script that has not been played. params structure definition: scene_scripts.

  • INSERT_PLAY_AUDIO: inserts an audio that is used to control a virtual avatar. The virtual avatar and background remain unchanged. params structure definition: PlayAudioInfo.

  • GET_CURRENT_PLAYING_SCRIPTS: queries the script list of the current round. The response is in the LivePlayingScriptList structure.

  • REFRESH_OUTPUT_URL: updates the RTMP stream push information of the current task. params structure definition: RefreshOutputUrlConfig.

  • REWRITE_INTERACTION_RULES: dynamically modifies an interaction rule. params structure definition: interaction_rules.

  • GET_LIVE_JOB_CONFIG_INFO: obtains room information in a task. params structure definition: SmartLiveRoomInfo.

  • CLEAN_UP_INSERT_COMMAND: clears the insertion commands that are not played. params structure definition: CleanUpInsertCommand.

  • RESET_EXIT_CONFIG: resets exit parameters. params structure definition: LiveExitConfig.

result

String

Command execution result.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs/26f06524-4f75-4b3a-a853-b649a21aaf66/command

{
  "command" : "INSERT_PLAY_SCRIPT",
  "params" : {
    "text_config" : {
      "text" : "I'll answer the questions raised by the audience in the comment area."
    },
    "play_type" : "APPEND",
    "rule_index" : "test-rule-index"
  }
}

Example Responses

Status code: 200

Succeeded.

{
  "command" : "GET_CURRENT_PLAYING_SCRIPTS",
  "result" : ""
}

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: Livestreaming Task Management