Querying Livestreaming Tasks of a Live Room

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

room_id

Yes

String

Script ID.

offset

No

Integer

Offset where the query starts.

limit

No

Integer

Number of items displayed on each page.

state

No

String

Task status. By default, all statuses are selected.

Multiple statuses can be queried. Use commas (,) to separate them,

for example, state=CREATING,PUBLISHED.

sort_key

No

String

Sorting field. Currently, only create_time is supported.

sort_dir

No

String

Sorting mode.

• asc: ascending order

• desc: descending order

asc is used by default.

create_since

No

String

Filter the records whose creation time is not earlier than the entered time.

create_until

No

String

Filter the records whose creation time is not later than the entered time.

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.

X-Request-Id

String

Request ID.

count

Integer

Total number of virtual human livestreaming tasks.

smart_live_jobs

Array of SmartLiveJob objects

Virtual human livestreaming task list.

job_id

String

Virtual human livestreaming task ID.

room_id

String

Live room ID.

room_name

String

Live room name.

state

String

Virtual human livestreaming task status.

• WAITING: The task is waiting for execution.

• PROCESSING: The task is being processed.

• SUCCEED: The task has been completed.

• FAILED: The task failed.

• BLOCKED: The live room was blocked.

duration

Float

Virtual human livestreaming duration, in seconds.

start_time

String

Start time of a virtual human livestreaming task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

end_time

String

End time of a virtual human livestreaming task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

error_info

ErrorResponse object

Virtual human livestreaming task error information.

create_time

String

Time when a virtual human livestreaming task is created. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

lastupdate_time

String

Last update time of a virtual human livestreaming task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

rtc_room_info

RTCRoomInfoList object

RTC room information.

live_event_report_url

String

URL for reporting livestreaming events. Users report their own livestreaming events to this URL to trigger intelligent interaction and automatic reply.

live_event_callback_config

LiveEventCallBackConfig object

Live event callback notification configuration.

rtc_callback_config

RTCLiveEventCallBackConfig object

RTC callback event configuration. Compatible processing. If the configuration is not carried, LIVE_PROGRESS is subscribed by default.

stream_duration

Float

Virtual human livestream push duration, in seconds.

block_reason

String

Information about live room blocking.

cover_url

String

Live room thumbnail URL

co_streamer_config

CoStreamerConfig object

Co-streamer configuration

live_job_log

LiveJobLog object

Livestreaming task records

error_code

String

Error code.

error_msg

String

Error description.

app_id

String

RTC application ID.

room_id

String

RTC room ID.

users

Array of RTCUserInfo objects

Information about users joining an RTC room.

user_type

String

User type.

• CAPTURE: Live assistant, which pushes video streams captured by cameras to RTC rooms.

• ANIMATION: Visual control service, which pulls video streams from RTC rooms to generate motion data.

• RENDER: Rendering service, which renders motion data into virtual human animations.

• PLAYER: Common viewer, who can watch the original video stream or virtual human animation video stream.

• INFERENCE_USER: Virtual human inference user, who receives audio streams from and pushes video streams to an RTC room.

• END_USER: Device user, who receives video streams from and pushes audio streams to an RTC room.

user_id

String

RTC user ID.

signature

String

RTC authentication token.

ctime

Long

Validity period. Timestamp, in seconds.

live_event_type_callback_url

String

Live event callback URL. HTTPS URL, which must contain an authentication string.

auth_type

String

Authentication type.

• None: The URL contains authentication.

• MSS_A: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are added to the URL. Value format: hwSecret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)&hwTime=hex(timestamp)

• MSS_A_HEAD: In HMACSHA256 signature mode, the hwSecret and hwTime parameters are placed in Head.

  Value format: x-hw-mss-secret=hmac_sha256(Key, URI (live_event_callback_url) + hwTime)

  x-hw-mss-time=hex(timestamp)

• MEITUAN_DEFAULT: This parameter is used only for Meituan's API callback.

key

String

Key

callback_event_type

Array of strings

Live event types in callbacks.

Currently, only the following options are supported:

• SHOOT_SCRIPT_SWITCH: script paragraph switching event

• RTMP_STREAM_STATE_CHANGE: RTMP link change callback event

• REPLY_COMMAND_FINISH: Playback is complete.

  The callback event structure is defined as follows:

• event_type: event type

• message: event description

  The SHOOT_SCRIPT_SWITCH event callback is defined as follows:

{
  "event_type":  "SHOOT_SCRIPT_SWITCH",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"Product 1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"Paragraph 2\"}"
}

The RTMP_STREAM_STATE_CHANGE callback is defined as follows:

{
  "event_type":  "RTMP_STREAM_STATE_CHANGE",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}"
}

The value of state can be CONNECTING, CONNECTED, DISCONNECTED, RECONNECTING, or END.

The REPLY_COMMAND_FINISH callback is defined as follows:

{
  "event_type":  "REPLY_COMMAND_FINISH",
  "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}"
}

rtc_callback_event_type

Array of strings

Live event types in RTC callbacks.

Currently, only the following options are supported:

LIVE_PROGRESS: live script progress notification

REPLY_COMMAND_FINISH: Playback is complete.

The callback event structure is defined as follows:

• message_type: message type

• data: message description

  The LIVE_PROGRESS event callback is defined as follows:

{
    "message_type": "live_progress_notify",
    "data": {
        "script_name": "Scene 1",
        "shoot_script_sequence_no": 2,
        "shoot_script_title": "Greeting",
        "offset": "247",
        "reply_id": "e87104f76d7546ce8a46ac6b04c49c3c"
    }
}

The REPLY_COMMAND_FINISH callback is defined as follows:

{
  "message_type": "reply_command_finish_notify",
  "data":"{
    "reply_id":"e87104f76d7546ce8a46ac6b04c49c3c"
  }"
}

voice_config

VoiceConfig object

Voice configuration parameter.

streamer_action

String

Behavior of the streamer when the co-streamer speaks.

• SILENCE: silent

• VOLUME_DOWN: decreased volume

voice_asset_id

String

Timbre asset ID.

speed

Integer

Speech speed.

The value defaults to 100 and ranges from 50 to 200.

pitch

Integer

Pitch.

The value defaults to 100 and ranges from 50 to 200.

volume

Integer

Volume.

The value defaults to 140 and ranges from 90 to 240.

interaction_records_url

String

Live interaction record file address

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

200

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

500

Internal service error.