更新时间:2025-11-21 GMT+08:00

启动数字人智能交互任务 - StartSmartChat

功能介绍

该接口用于启动数字人智能交互任务。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/{project_id}/smart-chat-rooms/{room_id}/smart-chat-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

room_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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

表3 请求Body参数

参数

是否必选

参数类型

描述

region

String

算力所在region。

  • cn-north-4: 北京4

  • cn-southwest-2: 贵阳1

client_id

String

业务ID。

room_type

String

数字人智能交互对话房间类型。

  • RTC: RTC房间

  • METALINK: METALINK房间

默认取值:

RTC

响应参数

状态码:202

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

job_id

String

智能交互对话任务ID。

rtc_room_info

RTCRoomInfoList object

RTC房间信息。

chat_subtitle_config

ChatSubtitleConfig object

对话字幕配置

video_config

ChatVideoConfigRsp object

视频输出配置。

voice_config_list

Array of VoiceConfigRsp objects

语音配置参数列表。

chat_video_type

String

智能交互对话端配置。

  • COMPUTER: 电脑端

  • MOBILE: 手机端

  • HUB: 大屏

is_transparent

Boolean

是否透明背景。

说明:
true: 透明背景

false: 非透明背景

默认取值:

false

region

String

算力所在region。

  • cn-north-4: 北京4

  • cn-southwest-2: 贵阳1

default_language

String

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

  • CN:简体中文。

  • EN:英语。

  • ESP:西班牙语(仅海外站点支持)

  • por:葡萄牙语(仅海外站点支持)

  • Arabic:阿拉伯语(仅海外站点支持)

  • Thai:泰语(仅海外站点支持)

默认取值:

CN

表6 RTCRoomInfoList

参数

参数类型

描述

app_id

String

RTC应用ID。

room_id

String

RTC房间ID。

users

Array of RTCUserInfo objects

加入RTC房间用户信息。

表7 RTCUserInfo

参数

参数类型

描述

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

表8 ChatSubtitleConfig

参数

参数类型

描述

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

表9 ChatVideoConfigRsp

参数

参数类型

描述

width

Integer

视频宽度。

单位:像素。

最小值320,最大值2560。

说明:
  • clip_mode=RESIZE时,当前支持1920x1080、1080x1920、1280x720、720x1280四种分辨率。

取值范围:

0~3840

height

Integer

视频高度。

单位:像素。

最小值320,最大值2560。

说明:
  • clip_mode=RESIZE时,当前支持1920x1080、1080x1920、1280x720、720x1280四种分辨率。

取值范围:

0~3840

表10 VoiceConfigRsp

参数

参数类型

描述

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

language_desc

String

语言描述

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-chat-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-chat-jobs

null

响应示例

状态码:202

成功。

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

状态码: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"
}

状态码

状态码

描述

202

成功。

400

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

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码