查询智能交互对话详情

project_id

是

String

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

room_id

是

String

智能交互对话ID。获取方法请参考创建智能交互对话。

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。

room_name

String

对话名称

room_description

String

对话描述。

video_config

VideoConfig object

视频输出配置。

说明：

• 智能交互仅支持配置codec=H264，bitrate，width，height，frame_rate。

model_asset_id

String

数字人模型资产ID。

voice_config

VoiceConfig object

语音配置参数。

说明：

*此参数将被废弃，请使用voice_config_list。

voice_config_list

Array of ChatVoiceConfig objects

语音配置参数列表。

robot_id

String

机器人ID。获取方法请参考创建应用。

concurrency

Integer

参数解释：

并发路数。

约束限制：

默认没有并发路数，如果不配置并发数量，则无法启动智能交互对话任务。

取值范围：

0-1024

default_language

String

默认语言，智能交互接口使用。默认值CN。

• CN：简体中文。

• EN：英语。

• ESP：西班牙语（仅海外站点支持）

• por：葡萄牙语（仅海外站点支持）

• Arabic：阿拉伯语（仅海外站点支持）

• Thai：泰语（仅海外站点支持）

background_config

BackgroundConfigInfo object

背景配置，background_config=null或background_type=null时为空背景配置。

layer_config

Array of LayerConfig objects

图层配置。

review_config

ReviewConfig object

内容审核配置

chat_subtitle_config

ChatSubtitleConfig object

对话字幕配置

chat_video_type

String

智能交互对话端配置。

• COMPUTER: 电脑端

• MOBILE: 手机端

• HUB: 大屏

exit_mute_threshold

Integer

参数解释：

静默退出时长。

取值范围：

0-1440

room_id

String

对话ID。

create_time

String

智能交互对话创建时间，格式遵循：RFC 3339 如“2021-01-10T08:43:17Z”。

update_time

String

智能交互对话更新时间，格式遵循：RFC 3339 如“2021-01-10T08:43:17Z”。

cover_url

String

对话封面图URL

is_pool_mode

Boolean

是否是资源池模式

默认取值：

false

chat_resource_config

Array of ChatResourceConfigInfo objects

资源配置。

clip_mode

String

参数解释：

输出视频的剪辑方式。

约束限制：

不涉及。

取值范围：

• RESIZE：视频缩放。

• CROP：视频裁剪。

默认取值：

RESIZE

codec

String

参数解释：

视频编码格式及视频文件格式。

约束限制：

仅分身数字人视频制作支持VP8和QTRLE编码。QTRLE编码时文本驱动字符数限制小于1500字，音频驱动音频长度小于5分钟。

QTRLE编码需要先申请开通白名单后才能使用

取值范围：

• H264：h264编码，输出mp4文件。

• VP8：vp8编码，输出webm文件。

• QTRLE：qtrle ，输出mov文件。

默认取值：

不涉及

bitrate

Integer

参数解释：

输出平均码率。单位：kbps。

约束限制：

• 分身数字人视频制作采用质量优先，可能会超过设置的码率。

• 分身数字人直播码率范围[1000, 8000]。

默认取值：

不涉及

取值范围：

40-30000

width

Integer

参数解释：

视频宽度。单位：像素。

约束限制：

• clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率。4K分辨率视频需要分身数字人模型支持4K的情况下才能使用。

• clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像宽度为width。

• 分身数字人直播目前只支持1080x1920、1920x1080。

默认取值：

不涉及

取值范围：

0-3840

height

Integer

参数解释：

视频高度。

单位：像素。

约束限制：

• clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率分辨率。

• clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像高度为height。

• 分身数字人直播目前只支持1080x1920、1920x1080。

默认取值：

不涉及

取值范围：

0-3840

frame_rate

String

参数解释：

帧率。单位：FPS。

约束限制：

分身数字人视频固定25FPS。

默认取值：

25

is_subtitle_enable

Boolean

参数解释：

输出的视频是否带字幕。

约束限制：

分身数字人直播暂时不支持字幕。

取值范围：

• true: 打开字幕

• false: 关闭字幕

默认取值：

false

subtitle_config

SubtitleConfig object

字幕配置。

disable_system_watermark

Boolean

参数解释：

输出的视频是否关闭系统水印。

约束限制：

目前该参数需要白名单的租户才起作用。

取值范围：

• true: 关闭系统水印

• false: 不关闭系统水印

默认取值：

false

dx

Integer

参数解释：

裁剪视频左上角像素点横坐标。

说明：

以模特分辨率为画布大小，比如1920*1080分辨率的模特，dx最小值是0，最大值是1920。

约束限制：

clip_mode= CROP时生效。

默认取值：

不涉及

取值范围：

-1920-3840

dy

Integer

参数解释：

裁剪视频左上角像素点纵坐标。

说明：

以模特分辨率为画布大小，比如1920*1080分辨率的模特，dy最小值是0，最大值是1080

约束限制：

clip_mode= CROP时生效。

默认取值：

不涉及

取值范围：

-1920-3840

is_enable_super_resolution

Boolean

参数解释：

视频是否开启超分。

约束限制：

仅分身数字人视频制作支持。

取值范围

• true: 开启

• false: 不开启

默认取值：

false

is_end_at_first_frame

Boolean

参数解释：

视频结束帧是否跟起始帧相同。需要多个数字人视频无缝拼接时设置成true。

约束限制：

仅分身数字人视频制作支持，当视频制作时插入动作标签后此设置将失效。

取值范围

• true: 开启

• false: 不开启

默认取值：

false

output_external_url

String

视频文件上传的外部URL。

说明：

• 需要先申请开通白名单后，才允许将视频上传到外部URL。

is_vocabulary_config_enable

Boolean

参数解释：

是否应用当前租户的读法配置

约束限制：

仅分身数字人视频制作支持。

取值范围

• true: 开启

• false: 不开启

默认取值：

true

dx

Integer

参数解释：

字幕框左下角像素点坐标。

约束限制：

不涉及。

默认取值：

不涉及。

取值范围：

0-1920

dy

Integer

参数解释：

字幕框左下角像素点坐标。

约束限制：

不涉及。

默认取值：

不涉及。

取值范围：

0-1920

h

Integer

参数解释：

字幕框高度。

约束限制：

参数h用于方便前端计算字幕框左上角坐标，后台不使用该参数。

取值范围：

0-1920

w

Integer

参数解释：

字幕框宽度。

约束限制：

• 字幕框宽度固定为屏幕宽度的80%

• 参数w用于方便前端计算字幕框左上角坐标，后台不使用该参数

取值范围：

0-1920

font_name

String

参数解释：

字体。当前支持的字体请参考服务支持的字体

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

HarmonyOS_Sans_SC_Black

font_size

Integer

参数解释：

字体大小。接口的取值范围为0-120，实际业务使用的取值范围要求为24-120，请以业务实际使用要求为准。

约束限制：

不涉及。

取值范围：

0-120

默认取值：

54

font_color

String

参数解释：

字幕字体颜色的RGB颜色值。

约束限制：

无

取值范围：

字符长度0-7位，固定长度

默认取值：

#FFFFFF

stroke_color

String

参数解释：

字幕字体描边颜色的RGB颜色值。

约束限制：

无

取值范围：

字符长度0-7位，固定长度

stroke_thickness

Float

参数解释：

字幕字体描边粗细像素值。

约束限制：

无

取值范围：

0-50

取值范围：

0-50

opacity

Float

参数解释：

字幕字体不透明度，0表示完全透明，1表示完全不透明。默认1。

约束限制：

无

取值范围：

0-1

取值范围：

0-1

默认取值：

1

sha256_font_enable

Boolean

参数解释：

字幕sha256计算是否包含字体。

约束限制：

不填默认不包含

取值范围：

• true: 包含

• false: 不包含

默认取值：

false

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

voice_asset_id

String

语音合成特征字符串

speed

Integer

语速。默认值100，最小值50，最大值200。

说明：

当取值为“100”时，表示一个成年人正常的语速，约为250字/分钟。

取值范围：

50-200

默认取值：

100

pitch

Integer

音高。默认值100，最小值50，最大值200。

取值范围：

50-200

默认取值：

100

volume

Integer

音量。默认值140，最小值90，最大值240。

取值范围：

90-240

默认取值：

140

provider

String

第三方TTS供应商类型。

• XIMALAYA：喜马拉雅TTS

• HUAWEI_EI：EI TTS

• MOBVOI：出门问问TTS

language

String

语言类型。默认值CN。

• CN：简体中文。

• EN：英语。

• ESP：西班牙语（仅海外站点支持）

• por：葡萄牙语（仅海外站点支持）

• Arabic：阿拉伯语（仅海外站点支持）

• Thai：泰语（仅海外站点支持）

默认取值：

CN

background_type

String

参数解释：

背景类型。

约束限制：

不涉及。

取值范围：

• IMAGE：图片背景，指定图片用作分身数字人背景。

• COLOR：纯色背景，指定颜色RGB值作为分身数字人背景。

默认取值：

不涉及

background_title

String

参数解释：

背景标题。

约束限制：

分身数字人视频制作此参数不生效。

取值范围：

字符长度0-256位

默认取值：

不涉及

human_position_2d

HumanPosition2D object

分身数字人在背景图片的位置设置。不设置默认在图片中间。

说明：

• 此参数废弃。分身数字人在背景中位置在layer_config参数中配置。

human_size_2d

HumanSize2D object

分身数字人在背景图片的大小设置。

说明：

• 此参数废弃。分身数字人在背景中大小在layer_config参数中配置。

background_cover_url

String

视频文件封面图片的下载URL。

演示素材为视频时有效。

说明：

• 分身数字人视频制作此参数不生效。

background_config

String

参数解释：

背景文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

• background_type=IMAGE时需要填写。

取值范围：

字符长度1-2048位

默认取值：

不涉及。

background_color_config

String

参数解释：

纯色背景的RGB颜色值。

约束限制：

background_type=COLOR时需要填写。

取值范围：

字符长度0-16位

默认取值：

#FFFFFF

background_asset_id

String

参数解释：

背景资产ID。

说明：

背景是背景图片时，填图片资产ID。

约束限制：

不涉及

取值范围：

字符长度0-64位

默认取值：

不涉及

background_image_config

BackgroundImageConfig object

背景图片大小及位置配置。

position

String

分身数字人在背景图片中的位置。

• LEFT： 左

• MIDDLE： 中

• RIGHT： 右

说明：

当position_x和position_y参数值存在时，position不生效

默认取值：

MIDDLE

position_x

Integer

分身数字人X轴位置，即分身数字图片底边中心点像素的X轴的像素值。

横屏（16:9）背景图片像素为1920x1080；竖屏（9:16）背景图片像素为1080x1920。

取值范围：

-1920-3840

position_y

Integer

分身数字Y轴位置，即分身数字图片底边中心点像素的Y轴的像素值。

横屏（16:9）背景图片像素为1920x1080；竖屏（9:16）背景图片像素为1080x1920。

取值范围：

-1920-3840

width

Integer

分身数字人宽度像素值。

横屏（16:9）背景图片像素为1920x1080；竖屏（9:16）背景图片像素为1080x1920。

取值范围：

1-7680

height

Integer

分身数字人高度像素值。

横屏（16:9）背景图片像素为1920x1080；竖屏（9:16）背景图片像素为1080x1920。

取值范围：

1-7680

dx

Integer

参数解释：

背景图片左上角像素点的X轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

需要保证背景图片要铺满画布。即dx <= 0，并且横屏时dx + width >=1920，竖屏时dx + width >=1080。

取值范围：

-5760-0

默认取值：

0

dy

Integer

参数解释：

背景图片左上角像素点的Y轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

需要保证背景图片要铺满画布。即dy <= 0，并且横屏时dy + height >=1080，竖屏时dy + height >=1920。

取值范围：

-5760-0

默认取值：

0

width

Integer

参数解释：

背景图片宽度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

需要保证背景图片要铺满画布。即width > 1080，并且横屏时dx + width >=1920，竖屏时dx + width >=1080。

取值范围：

1-7680

height

Integer

参数解释：

背景图片高度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

需要保证背景图片要铺满画布。height> 1080，并且横屏时dy + height >=1080，竖屏时dy + height >=1920。

取值范围：

1-7680

layer_type

String

参数解释：

图层类型。

约束限制：

不涉及。

取值范围：

• HUMAN: 人物图层

• IMAGE： 素材图片图层

• VIDEO： 素材视频图层

• TEXT: 素材文字图层

默认取值：

不涉及

asset_id

String

参数解释：

图层所需资产的资产id，外部资产信息无需填写。

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

不涉及

group_id

String

参数解释：

多场景素材编组。同一group_id的素材，在应用全局时共享位置信息。

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

不涉及

position

LayerPositionConfig object

图层位置配置。

size

LayerSizeConfig object

图层大小配置。

rotation

LayerRotationConfig object

图层旋转配置。

image_config

ImageLayerConfig object

素材图片图层配置。

video_config

VideoLayerConfig object

素材视频图层配置。

text_config

TextLayerConfig object

素材文字图层配置。

dx

Integer

参数解释：

图层左上角像素点的X轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

dy

Integer

参数解释：

图层图片左上角像素点的Y轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

layer_index

Integer

参数解释：

图片、视频、人物图的层顺序。

说明：

图层顺序为从1开始的整数，底层图层顺序是1，往上依次增加。

约束限制：

如果出现重复则重复图层叠加关系随机。

取值范围：

1-100

默认取值：

100

width

Integer

参数解释：

图层图片左上角像素点的Y轴位置值图层图片宽度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

1-7680

height

Integer

参数解释：

图层图片高度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。|

取值范围：

1-7680

angle

Integer

参数解释：

旋转角度。

取值范围：

角度范围0-360度。

默认取值：

0度。

约束限制：

以素材中心点旋转。

取值范围：

0-360

image_url

String

参数解释：

图片文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

取值范围：

字符长度1-2048位。

默认取值：

不涉及

video_url

String

参数解释：

视频文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

取值范围：

字符长度1-2048位。

默认取值：

不涉及。

video_cover_url

String

参数解释：

视频封面文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

取值范围：

字符长度1-2048位。

默认取值：

不涉及。

loop_count

Integer

参数解释：

循环播放视频次数。

特殊取值：

• 0：表示不播放

• -1：表示持续循环播放

约束限制：

不涉及。

取值范围：

-1-100

默认取值：

-1

video_sound

Integer

参数解释：

视频声音大小，0 - 100，表示开启视频声音原视频音量的百分比

特殊取值：

• 0：表示不开启声音（默认值）

约束限制：

不涉及。

取值范围：

0-100

is_play_the_entire_video

Boolean

参数解释：

是否播放完整个视频，true表示播放完整个视频，false表示当场景文本/音频结束时，视频也同时不再播放。

特殊取值：

默认值为false

约束限制：

不涉及。

text_context

String

参数解释：

文字图层的文本，内容需做Base64编码。

示例：若想添加文字水印“测试文字水印”，那么text_context的值为：5rWL6K+V5paH5a2X5rC05Y2w

约束限制：

不涉及。

取值范围：

字符长度0-1024位。

默认取值：

不涉及。

font_name

String

字体。当前支持的字体请参考服务支持的字体

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

HarmonyOS_Sans_SC_Black

font_size

Integer

参数解释：

字体大小（像素）。接口的取值范围为0-120，实际业务使用的取值范围要求为4-120，请以业务实际使用要求为准。

约束限制：

不涉及。

取值范围：

0-120

默认取值：

16

font_color

String

参数解释：

字体颜色。RGB颜色值。

约束限制：

不涉及。

取值范围：

字符长度0-16位

默认取值：

#FFFFFF

no_need_review

Boolean

免审核。 目前仅白名单用户可使用此参数，非白名单用户跟随系统策略审核。

dx

Integer

参数解释：

字幕左上角像素点坐标。

横屏（16:9）视频像素为1920x1080；竖屏（9:16）视频像素为1080x1920。

取值范围：

0-1920

dy

Integer

参数解释：

字幕左上角像素点坐标。

横屏（16:9）视频像素为1920x1080；竖屏（9:16）视频像素为1080x1920。

取值范围：

0-1920

width

Integer

参数解释：

图层图片宽度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

取值范围：

1-7680

height

Integer

参数解释：

图层图片高度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

取值范围：

1-7680

resource_id

String

资源id

count_resource

Integer

资源数量

取值范围：

0-10000

resource_source

String

资源来源。

• PURCHASED: 购买

• SP_ALLOCATED：SP分配

• ADMIN_ALLOCATED：系统管理员分配

说明：

• 开通按需；购买按需套餐包、一次性资源、包周期等都属于PURCHASED。

charge_mode

String

资源计费类型。

• PERIODIC: 包周期

• ONE_TIME：一次性计费

• ON_DEMAND: 按需计费

说明：

• 一次性计费包括：租户订购的一次性资源，SP管理员分配给租户的一次性资源，SP管理员分配给租户的按需套餐包资源，系统管理员分配的资源（分钟数等）。

resource_nums

Integer

资源数量。智能交互并发路数。

取值范围：

0-10000000

resource_available_nums

Integer

可用资源数量。智能交互并发路数。

取值范围：

0-10000000

status

String

资源状态。

• ACTIVE: 正常

• FREEZE：冻结

• DELETED：退订或过期

expire_time

String

资源过期时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

200

成功。

400

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

401

未鉴权或鉴权失败。

404

无内容。

500

内部服务错误。