# 查询数字人智能交互任务列表 - ListSmartChatJob #### 功能介绍 该接口用于查询数字人智能交互任务列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。 #### URI GET /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | | room_id | 是 | String | 智能交互对话ID，获取方法请参考[创建智能交互对话直播间](https://support.huaweicloud.com/api-metastudio/CreateSmartChatRoom.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | state | 否 | String | 任务状态，默认所有状态。 可多个状态查询，使用英文逗号分隔。 如state=CREATING,PUBLISHED | | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | | X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 数字人智能交互对话任务总数。 **取值范围：** 0\~2147483647 | | smart_chat_jobs | Array of [SmartChatJobBaseInfo] objects | 数字人智能交互对话任务列表。 | 表6SmartChatJobBaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | 数字人智能交互对话任务ID。 | | state | String | 数字人智能交互对话任务的状态。 - WAITING: 等待 - PROCESSING: 处理中 - SUCCEED: 成功 - FAILED: 失败 - DELETING: 删除中 | | 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"。 | | chat_subtitle_config | [SmartChatSubtitleConfig] object | 对话字幕配置 | | video_config | [SmartChatVideoConfig] object | 视频输出配置。 | | voice_config_list | Array of [SmartChatVoiceConfig] objects | 语音配置参数列表。 | | chat_video_type | String | 智能交互对话端配置。 - COMPUTER: 电脑端 - MOBILE: 手机端 - HUB: 大屏 | | is_transparent | Boolean | 是否透明背景 **默认取值：** false | | default_language | String | 默认语言，智能交互接口使用。默认值CN。 - CN：中文。 - EN：英文。 - ESP：西班牙语（仅海外站点支持） - por：葡萄牙语（仅海外站点支持） - Arabic：阿拉伯语（仅海外站点支持） - Thai：泰语（仅海外站点支持） - fr：法语（仅海外站点支持） **默认取值：** CN | | client_id | String | clientId | | is_pool_mode | Boolean | 是否是资源池模式 **默认取值：** false | | job_finish_reason | String | 对话结束原因 - NORMAL：正常结束 - MUTE_TIMEOUT：静音超时 | 表7ErrorResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | 表8SmartChatSubtitleConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表9SmartChatVideoConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | width | Integer | 视频宽度。 单位：像素。 最小值320，最大值2560。 说明： - clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率。4K分辨率视频需要分身数字人模型支持4K的情况下才能使用。 - clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像宽度为width。 - 分身数字人直播目前只支持1080x1920。 **取值范围：** 0\~3840 | | height | Integer | 视频高度。 单位：像素。 最小值320，最大值2560。 说明： - clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率分辨率。 - clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像高度为height。 - 分身数字人直播目前只支持1080x1920。 **取值范围：** 0\~3840 | 表10SmartChatVoiceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：泰语（仅海外站点支持） - fr：法语（仅海外站点支持） **默认取值：** CN | | language_desc | String | 语言描述。 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/smart-chat-rooms/41c86xxxxxx34253850af102cdxxxxxx/smart-chat-jobs ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "count" : 1, "smart_chat_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" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回。 | | 400 | 请求传参异常，包含错误码及对应描述。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。