# 查询智能交互对话列表 - ListSmartChatRooms #### 功能介绍 该接口用于智能交互对话列表。 #### 调用方法 请参见[如何调用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}/smart-chat-rooms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | 每页显示的条目数量。 **取值范围：** 1\~100 **默认取值：** 10 | | room_name | 否 | String | 按智能交互对话名称模糊查询。 | | model_name | 否 | String | 按形象名称模糊查询。 | | start_time | 否 | String | 最近智能交互对话任务起始时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | end_time | 否 | String | 结束时间。格式遵循：RFC 3339 如"2021-01-10T10:43:17Z"。 | #### 请求参数 表3请求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。不允许输入中文。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 智能交互对话总数。 **取值范围：** 0\~2147483647 | | count_concurrency | Integer | **参数解释**： 智能交互对话总并发路数。 **取值范围：** 0\~1024000 | | count_client_nums | Integer | **参数解释**： 智能交互对话按接入端计费总路数。 **取值范围：** 0\~1024000 | | count_client_nums_token | Integer | **参数解释**： 智能交互对话按接入端计费（Token）总路数。 **取值范围：** 0\~1024000 | | smart_chat_rooms | Array of [SmartChatRoomBaseInfo] objects | 智能交互对话列表。 | 表6SmartChatRoomBaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | room_id | String | 智能交互对话ID | | room_name | String | 智能交互对话名称 | | room_description | String | 智能交互对话描述。 | | robot_id | String | 机器人ID。 | | cover_url | String | 对话封面图URL | | model_infos | [ModelInfo] object | 数字人模型信息 | | voice_config | [VoiceConfig] object | 语音配置参数。 说明： \*此参数将被废弃，请使用voice_config_list。 | | billing_mode | String | 计费模式，默认值CONCURRENCY - CONCURRENCY：并发计费 - CLIENT：按接入端计费 - CLIENT_TOKENS: 按接入端计费（TOKENS） | | reuse_resource | Boolean | 是否允许使用未分配的并发数（端模式下不能复用），默认不使用。 | | concurrency | Integer | **参数解释**： 并发路数。 **取值范围：** 0\~1024 | | client_nums | Integer | **参数解释**： 允许接入终端端数量。 **取值范围：** 0\~1024 | | voice_config_list | Array of [VoiceConfigRsp] objects | 语音配置参数列表。 | | default_language | String | 默认语言，智能交互接口使用。默认值CN。 - CN：简体中文。 - EN：英语。 - ESP：西班牙语（仅海外站点支持） - por：葡萄牙语（仅海外站点支持） - Arabic：阿拉伯语（仅海外站点支持） - Thai：泰语（仅海外站点支持） - fr：法语（仅海外站点支持） **默认取值：** CN | | create_time | String | 创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | exit_mute_threshold | Integer | **参数解释**： 静默退出时长。 **取值范围：** 0\~1440 | 表7ModelInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | model_asset_id | String | 模型资产ID，可以从资产库中查询。 | | asset_name | String | 资产名称 | | backup_model_asset_ids | Array of strings | 主播轮换时备选主播数字人资产ID（仅形象资产，不包含音色），可以从资产库中查询。 | 表8VoiceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | voice_asset_id | String | **参数解释**： 音色资产ID，可以从资产库中查询。 音色ID的查询操作，详见[查询预置音色ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0054.html)。 **约束限制**： 不涉及。 **取值范围**： 字符长度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 | 表9VoiceConfigRsp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-chat-rooms ``` #### 响应示例 **状态码：200** 成功。 ``` { "count" : 1, "smart_chat_rooms" : [ { "room_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "room_name" : "云笙展厅", "room_description" : "云笙", "create_time" : "2022-11-30T06:59:55Z", "update_time" : "2022-12-05T12:30:37Z" } ] } ``` **状态码：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 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。