查询租户所有数字人直播任务列表 - ListSmartLiveJobs
功能介绍
该接口用于查询租户所有数字人智能直播任务列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/smart-live-jobs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Integer | 偏移量,表示从此偏移量开始查询。 取值范围: 0~2147483647 默认取值: 0 |
limit | 否 | Integer | 每页显示的条目数量。 取值范围: 1~100 默认取值: 10 |
state | 否 | String | 任务状态,默认所有状态。 可多个状态查询,使用英文逗号分隔。 如state=CREATING,PUBLISHED |
sort_key | 否 | String | 排序字段,支持的排序方式有: |
sort_dir | 否 | String | 排序方式。 默认asc升序。 |
create_since | 否 | String | 过滤创建时间>=输入时间的记录。 |
create_until | 否 | String | 过滤创建时间<=输入时间的记录。 |
room_name | 否 | 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 | 参数解释: 数字人直播任务总数。 取值范围: 0~2147483647 |
smart_live_jobs | Array of SmartLiveJob objects | 数字人直播任务列表。 |
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | 数字人直播任务ID。 |
room_id | String | 直播间ID |
room_name | String | 直播间名称 |
state | String | 数字人直播任务的状态。 |
duration | Float | 参数解释: 数字人直播时长,单位秒。 取值范围: 0~2147483647 |
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_report_config | LiveEventReportConfig object | 直播事件上报配置 |
live_event_callback_config | LiveEventCallBackConfig object | 直播事件HTTPS回调通知配置 |
rtc_callback_config | RTCLiveEventCallBackConfig object | RTC回调事件配置。兼容处理,未携带配置则默认订阅LIVE_PROGRESS |
stream_duration | Float | 参数解释: 数字人直播推流时长,单位秒。 取值范围: 0~2147483647 |
block_reason | String | 封禁信息 |
cover_url | String | 直播间封面图URL |
co_streamer_config | CoStreamerConfig object | 助播配置 |
live_job_log | LiveJobLog object | 直播任务记录 |
relation_live_platform_info | PlatformLiveDetailInfo object | 平台直播信息 |
used_resource_type | String | 使用的资源类型。 |
is_ai_mark_on | Boolean | AI标识开关 默认取值: false |
参数 | 参数类型 | 描述 |
|---|---|---|
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 | 有效期。时间戳,单位:秒。 取值范围: 0~4294967295 |
参数 | 参数类型 | 描述 |
|---|---|---|
live_event_report_url | String | 直播事件上报地址。用户将自行获取的直播间事件上报到此地址,用于触发智能互动,自动回复话术。 |
auth_key | String | 直播事件上报认证key。请求直播事件上报地址时,把auth_key放到请求头域中。如"auth_key:50fa6bb8aa2b3f88xxxx..." |
expires_time | Long | 直播事件url上报过期时间。请求直播事件上报地址时,把expires_time放到请求头域中。如"expires_time:1757464200000" 取值范围: 0~4102415999000 |
参数 | 参数类型 | 描述 |
|---|---|---|
rtc_callback_event_type | Array of strings | RTC回调的直播事件类型列表。 当前仅支持如下取值: 回调事件结构体定义:
|
参数 | 参数类型 | 描述 |
|---|---|---|
voice_config | VoiceConfig object | 语音配置参数。 |
streamer_action | String | 参数解释: 助播出声时主播行为设置。 约束限制: 不涉及 取值范围: 默认取值: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
voice_asset_id | String | 参数解释: 音色资产ID,可以从资产库中查询。 音色ID的查询操作,详见查询预置音色ID。 约束限制: 不涉及。 取值范围: 字符长度1-256位。 默认取值: 不涉及。 |
speed | Integer | 参数解释: 语速。50表示0.5倍语速,100表示正常语速,200表示2倍语速。 当取值为“100”时,表示一个成年人的正常语速,约为250字/分钟。 约束限制: 不涉及。 取值范围: 50~200 默认取值: 100 |
pitch | Integer | 参数解释: 音高。 约束限制: 不涉及。 取值范围: 50~200 默认取值: 100 |
volume | Integer | 参数解释: 音量。 约束限制: 不涉及。 取值范围: 90~240 默认取值: 140 |
参数 | 参数类型 | 描述 |
|---|---|---|
interaction_records_url | String | 直播互动记录文件地址 |
job_config_records_url | String | 任务配置记录文件地址 |
scripts_records_url | String | 剧本播放记录文件地址 |
command_reviced_records_url | String | 命令接受记录文件地址 |
command_exec_records_url | String | 命令执行记录文件地址 |
参数 | 参数类型 | 描述 |
|---|---|---|
platform_id | String | 直播平台ID。 |
platform | String | 直播平台。美团填写meituan |
account | String | 授权账号信息。 美团平台对应:opBizCode |
live_id | String | 直播ID。如果配置,则段落切换回调中会携带该信息。 美团对应liveId |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
GET https://metastudio.cn-north-4.myhuaweicloud.com/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"
} 状态码
状态码 | 描述 |
|---|---|
200 | 成功。 |
400 | 请求传参异常,包含错误码及对应描述。 |
401 | 未鉴权或鉴权失败。 |
500 | 内部服务错误。 |
错误码
请参见错误码。

