Querying Virtual Human Intelligent Livestreaming Task Details
Function
Queries virtual human intelligent livestreaming task details.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}
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 |
Script ID. |
job_id |
Yes |
String |
Task ID. |
Request 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
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Request ID. |
Parameter |
Type |
Description |
---|---|---|
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.
|
duration |
Float |
Details: Virtual avatar livestreaming duration, in second. Value range: 0-2147483647 |
start_time |
String |
Start time of a virtual avatar livestreaming task. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z. |
end_time |
String |
End time of a virtual avatar 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 avatar 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 avatar 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 HTTPS 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 |
Details: Virtual avatar livestream push duration, in second. Value range: 0-2147483647 |
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 |
relation_live_platform_info |
PlatformLiveDetailInfo object |
Platform live broadcast information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Parameter |
Type |
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. |
Parameter |
Type |
Description |
---|---|---|
user_type |
String |
User type.
|
user_id |
String |
RTC user ID. |
signature |
String |
RTC authentication token. |
ctime |
Long |
Validity period. Timestamp, in seconds. Value range: 0-4294967295 |
Parameter |
Type |
Description |
---|---|---|
live_event_type_callback_url |
String |
Details: Live event callback address, which is an HTTPS address. Constraints: N/A Options: The value contains 0 to 2,048 characters. Default value: N/A |
auth_type |
String |
Details: Authentication type. Constraints: N/A Options:
Default value: NONE |
key |
String |
Details: Key. Constraints: N/A Options: The value contains 0 to 32 characters. Default value: N/A |
callback_event_type |
Array of strings |
Details: Live event types in callbacks. Constraints: N/A Options: Currently, only the following options are supported:
The callback event structure is defined as follows:
|
Parameter |
Type |
Description |
---|---|---|
rtc_callback_event_type |
Array of strings |
Live event types in RTC callbacks. Currently, only the following options are supported:
The callback event structure is defined as follows:
|
Parameter |
Type |
Description |
---|---|---|
voice_config |
VoiceConfig object |
Voice configuration parameter. |
streamer_action |
String |
Details: Behavior of the streamer when the co-streamer speaks. Constraints: N/A Options:
Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
voice_asset_id |
String |
Details: Timbre asset ID, which can be queried from the asset library. Constraints: N/A Options: The value contains 1 to 256 characters. Default value: N/A |
speed |
Integer |
Details: Speaking speed. 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed. The value 100 indicates the normal speaking speed of an adult, which is about 150 words per minute. Constraints: N/A Value range: 50-200 Default value: 100 |
pitch |
Integer |
Details: Pitch. Constraints: N/A Value range: 50-200 Default value: 100 |
volume |
Integer |
Details: Volume. Constraints: N/A Value range: 90-240 Default value: 140 |
Parameter |
Type |
Description |
---|---|---|
interaction_records_url |
String |
Live interaction record file address |
Parameter |
Type |
Description |
---|---|---|
platform_id |
String |
Live TV platform ID. |
platform |
String |
Live broadcast platform. Meituan fills in meituan |
account |
String |
Authorization account information. Meituan platform: opBizCode |
live_id |
String |
Live TV channel ID. If this parameter is set, the live TV channel ID is carried in the segment switchback callback. LiveId corresponding to the Meituan. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
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
Example Responses
Status code: 200
Succeeded.
{ "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "state" : "WAITING", "start_time" : "2022-01-18T16:29:36Z", "end_time" : "2022-01-18T16:30:36Z", "duration" : 60 }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot