查询租户所有数字人直播任务列表

project_id

是

String

项目ID，获取方法请参考获取项目ID。

offset

否

Integer

偏移量，表示从此偏移量开始查询。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

每页显示的条目数量。

取值范围：

1-100

默认取值：

10

state

否

String

任务状态，默认所有状态。

可多个状态查询，使用英文逗号分隔。

如state=CREATING,PUBLISHED

sort_key

否

String

排序字段，支持的排序方式有：

• 按创建时间排序：create_time

• 按更新时间排序：update_time

• 按资产排序：asset_order

sort_dir

否

String

排序方式。

• asc：升序

• desc：降序

默认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。不允许输入中文。

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

数字人直播任务的状态。

• WAITING: 等待

• PROCESSING: 处理中

• SUCCEED: 成功

• FAILED: 失败

• BLOCKED: 封禁

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

平台直播信息

error_code

String

错误码。

error_msg

String

错误描述。

app_id

String

RTC应用ID。

room_id

String

RTC房间ID。

users

Array of RTCUserInfo objects

加入RTC房间用户信息。

user_type

String

用户类型。

• CAPTURE: 直播助手，将摄像头获取视频流推送到RTC房间

• ANIMATION: VDS服务，从RTC房间拉视频流生成动作数据

• RENDER: 渲染服务，将动作数据渲染成数字人动画

• PLAYER: 普通观看方，可选择原始视频流或者数字人动画视频流观看

• INFERENCE_USER: 数字人推理端用户。从RTC房间接收音频流，并推送视频流到RTC房间

• END_USER: 端侧用户。从推送音频流到RTC房间，并从RTC房间接收视频流

user_id

String

RTC用户ID。

signature

String

RTC鉴权token。

ctime

Long

有效期。时间戳，单位：秒。

取值范围：

0-4294967295

live_event_type_callback_url

String

参数解释：

直播事件回调地址，为https地址。

约束限制：

不涉及。

取值范围：

字符长度0-2048位。

默认取值：

不涉及。

auth_type

String

参数解释：

认证类型。

约束限制：

不涉及。

取值范围：

• NONE：URL中自带认证。

• MSS_A：HMACSHA256签名模式，在URL中追加参数hwSecret、hwTime。

  取值方式：hwSecret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime)&hwTime=hex(timestamp)

• MSS_A_HEAD：HMACSHA256签名模式，参数hwSecret、hwTime放置在Head中。

  取值方式：x-hw-mss-secret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime)

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

• MEITUAN_DEFAULT：仅用于美团平台调用回调使用。

默认取值：

NONE

key

String

参数解释：

密钥Key。

约束限制：

不涉及。

取值范围：

字符长度0-32位。

默认取值：

不涉及。

callback_event_type

Array of strings

参数解释：

回调的直播事件类型列表。

约束限制：

不涉及。

取值范围：

当前仅支持如下取值：

• SHOOT_SCRIPT_SWITCH：剧本段落切换事件。

• RTMP_STREAM_STATE_CHANGE：RTMP链接发生变化回调事件。

• REPLY_COMMAND_FINISH：回复播放完成通知。

回调事件结构体定义：

• event_type：事件类型。

• message：事件描述。

  • SHOOT_SCRIPT_SWITCH事件回调定义如下：

    {
      "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联络不再重连，链路已结束。

  • REPLY_COMMAND_FINISH回调定义如下：

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

rtc_callback_event_type

Array of strings

RTC回调的直播事件类型列表。

当前仅支持如下取值：

• LIVE_PROGRESS：直播剧本进度通知。

• REPLY_COMMAND_FINISH：回复播放完成通知。

回调事件结构体定义：

• message_type：消息类型。

• data：消息描述。

  • LIVE_PROGRESS事件回调定义如下：

    {
        "message_type": "live_progress_notify",
        "data": {
            "script_name": "场景一",
            "shoot_script_sequence_no": 2,
            "shoot_script_title": "引导语",
            "offset": "247",
            "reply_id": "e87104f76d7546ce8a46ac6b04c49c3c"
        }
    }

  • REPLY_COMMAND_FINISH回调定义如下：

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

voice_config

VoiceConfig object

语音配置参数。

streamer_action

String

参数解释：

助播出声时主播行为设置。

约束限制：

不涉及

取值范围：

• SILENCE：静默

• VOLUME_DOWN：音量降低

默认取值：

不涉及。

voice_asset_id

String

参数解释：

音色资产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

直播互动记录文件地址

platform_id

String

直播平台ID。

platform

String

直播平台。美团填写meituan

account

String

授权账号信息。

美团平台对应：opBizCode

live_id

String

直播ID。如果配置，则段落切换回调中会携带该信息。

美团对应liveId

BadRequest

AnyType

请求传参异常，包含错误码及对应描述。

Unauthorized

AnyType

未鉴权或鉴权失败。

InternalServiceError

AnyType

内部服务错误。

200

成功。

400

请求传参异常，包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。