查询某个智能直播间下直播任务列表
功能介绍
该接口用于查询某个智能直播间的直播任务列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
room_id |
是 |
String |
剧本ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
state |
否 |
String |
任务状态,默认所有状态。 可多个状态查询,使用英文逗号分隔。 如state=CREATING,PUBLISHED |
sort_key |
否 |
String |
排序字段,目前只支持create_time。 |
sort_dir |
否 |
String |
排序方式。
默认asc升序。 |
create_since |
否 |
String |
过滤创建时间>=输入时间的记录。 |
create_until |
否 |
String |
过滤创建时间<=输入时间的记录。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
数字人直播任务总数。 |
smart_live_jobs |
Array of SmartLiveJob objects |
数字人直播任务列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
数字人直播任务ID。 |
room_id |
String |
直播间ID |
room_name |
String |
直播间名称 |
state |
String |
数字人直播任务的状态。
|
duration |
Float |
数字人直播时长,单位秒。 |
start_time |
String |
数字人直播任务开始时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
end_time |
String |
数字人直播任务结束时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
error_info |
ErrorResponse object |
数字人直播任务出错信息。 |
create_time |
String |
数字人直播任务创建时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
lastupdate_time |
String |
数字人直播任务最后更新时间。格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
rtc_room_info |
RTCRoomInfoList object |
RTC房间信息。 |
live_event_report_url |
String |
直播事件上报地址。用户将自行获取的直播间事件上报到此地址,用于触发智能互动,自动回复话术。 |
live_event_callback_config |
LiveEventCallBackConfig object |
直播事件回调通知配置 |
stream_duration |
Float |
数字人直播推流时长,单位秒 |
block_reason |
String |
封禁信息 |
cover_url |
String |
直播间封面图URL |
co_streamer_config |
CoStreamerConfig object |
助播配置 |
live_job_log |
LiveJobLog object |
直播任务记录 |
参数 |
参数类型 |
描述 |
---|---|---|
app_id |
String |
RTC应用ID。 |
room_id |
String |
RTC房间ID。 |
users |
Array of RTCUserInfo objects |
加入RTC房间用户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_type |
String |
用户类型。
|
user_id |
String |
RTC用户ID。 |
signature |
String |
RTC鉴权token。 |
ctime |
Long |
有效期。时间戳,单位:秒。 |
参数 |
参数类型 |
描述 |
---|---|---|
live_event_type_callback_url |
String |
直播事件回调地址。https地址,需自带鉴权串。 |
auth_type |
String |
认证类型。
|
key |
String |
密钥Key |
callback_event_type |
Array of strings |
回调的直播事件类型列表。 当前仅支持取值: SHOOT_SCRIPT_SWITCH,剧本段落切换事件。 RTMP_STREAM_STATE_CHANGE, RTMP链接发生变化回调事件。 回调事件结构体定义:
{ "event_type": "SHOOT_SCRIPT_SWITCH", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"商品1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"段落2\"}" } RTMP_STREAM_STATE_CHANGE回调定义如下: { "event_type": "RTMP_STREAM_STATE_CHANGE", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}" } 其中state取值: CONNECTING 链路连接中, CONNECTED 链路已连接,DISCONNECTED 链路已断开,RECONNECTING 链路重连中, END 联络不再重连,链路已结束 |
参数 |
参数类型 |
描述 |
---|---|---|
voice_config |
VoiceConfig object |
语音配置参数。 |
streamer_action |
String |
助播出声时主播行为。
|
参数 |
参数类型 |
描述 |
---|---|---|
voice_asset_id |
String |
音色资产ID。 |
speed |
Integer |
语速。 默认值100,最小值50,最大值200。 说明:
|
pitch |
Integer |
音高。 默认值100,最小值50,最大值200。 |
volume |
Integer |
音量。 默认值140,最小值90,最大值240。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs
响应示例
状态码: 200
成功。
{ "count" : 1, "smart_live_jobs" : [ { "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 } ] }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 500
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class ListSmartLiveSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); ListSmartLiveRequest request = new ListSmartLiveRequest(); request.withRoomId("{room_id}"); try { ListSmartLiveResponse response = client.listSmartLive(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) \ client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSmartLiveRequest() request.room_id = "{room_id}" response = client.list_smart_live(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSmartLiveRequest{} request.RoomId = "{room_id}" response, err := client.ListSmartLive(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。