Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Livestreaming Task Management/ Listing Virtual Avatar Live-streaming Insert Commands
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing Virtual Avatar Live-streaming Insert Commands

Function

Lists virtual avatar livestreaming insert commands.

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}/smart-live-jobs/{job_id}/command/insert-commands

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

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

Value range:

0~2147483647

insert_commands

Array of InsertCommandItem objects

Inserted playback commands.
Table 6 InsertCommandItem

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: 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_INTERACTION_RULES: modifies an interaction rule. params structure definition: PlayAudioInfo.

params

Object

Command parameter.

source

String

Command source.

  • EXTERNAL: external command

  • AUTO: automatically triggered

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

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

Example Responses

Status code: 200

Succeeded.

{
  "count" : 10,
  "insert_commands" : [ {
    "command_id" : "xxxxxxx",
    "command" : "INSERT_PLAY_AUDIO"
  } ]
}

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