# 合成接口
#### 功能介绍
使用预置音色或注册的声音合成语音。
#### URI
POST /v1/{project_id}/vcs/voices/clone
#### 请求消息
表1请求参数说明 
| 参数     | 是否必选 | 参数类型   | 描述                   |
|:---|:---|:---|:---|
| text   | 是    | String | 待合成文本，文本的长度不大于300字符。 |
| config | 是    | Object | 语音合成配置信息。            |
   
表2config 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                     |
|:---|:---|:---|:---|
| audio_format | 否    | String  | 合成音频的格式。支持wav、mp3pcm，默认wav。                                                            |
| sample_rate  | 否    | String  | 合成音频的采样率。支持8kHz、16kHz、24kHz，默认16kHz。                                                   |
| voice_name   | 是    | String  | 合成所使用的音色名称，可选择用户注册的音色或预置音色。预置音色取值范围参考[表3 预置音色取值范围]。 |
| speed        | 否    | Integer | 语速。 取值范围：-500\~500 默认值：0   |
| pitch        | 否    | Integer | 音高。 取值范围： -500\~500 默认值：0 |
| volume       | 否    | Integer | 音量。 取值范围：0\~100 默认值：50     |
   
 表3预置音色取值范围 
| 名称  | voice_name                  | 类型   | 使用场景 | 支持采样率（Hz）  |
|:---|:---|:---|:---|:---|
| 华小莉 | chinese_huaxiaoli_common    | 标准女声 | 中英混合 | 8k/16k/24k |
| 华小智 | chinese_huaxiaozhi_common   | 男童声  | 中英混合 | 8k/16k/24k |
| 华小天 | chinese_huaxiaotian_common  | 朝气男声 | 中英混合 | 8k/16k/24k |
| 华小媛 | chinese_huaxiaoyuan_common  | 成熟女声 | 中英混合 | 8k/16k/24k |
| 华小静 | chinese_huaxiaojing_common  | 女童声  | 中英混合 | 8k/16k/24k |
| 华小博 | chinese_huaxiaobo_common    | 标准男声 | 中英混合 | 8k/16k/24k |
| 华小柔 | chinese_huaxiaorou_common   | 标准女声 | 中英混合 | 8k/16k/24k |
| 华小悠 | chinese_huaxiaoyou_common   | 嘹亮女声 | 中英混合 | 8k/16k/24k |
| 华小晴 | chinese_huaxiaoqing_common  | 青春女声 | 中英混合 | 8k/16k/24k |
| 华小溪 | chinese_huaxiaoxi_common    | 温柔女声 | 中英混合 | 8k/16k/24k |
| 华小彤 | chinese_huaxiaotong_common  | 俏皮女声 | 中英混合 | 8k/16k/24k |
| 华小雅 | chinese_huaxiaoya_common    | 标准女声 | 中英混合 | 8k/16k/24k |
| 华小伟 | chinese_huaxiaowei_common   | 成熟男声 | 中英混合 | 8k/16k/24k |
| 华小帅 | chinese_huaxiaoshuai_common | 标准男声 | 中英混合 | 8k/16k/24k |
| 华小杰 | chinese_huaxiaojie_common   | 温柔男声 | 中英混合 | 8k/16k/24k |
   
#### 响应消息
**状态码： 200**
表4响应参数说明 
| 参数       | 参数类型   | 描述                      |
|:---|:---|:---|
| trace_id | String | 服务内部的令牌，可用于在日志中追溯具体流程。  |
| result   | Object | 调用成功时为合成语音内容，调用失败时无此字段。 |
   
表5result数据结构 
| 参数   | 参数类型   | 描述                                                                       |
|:---|:---|:---|
| data | String | 生成的语音数据，以Base64编码格式返回。用户如需生成音频，需要将返回的Base64编码格式的数据解码成byte数组，再保存为对应格式的音频。 |
   
**状态码： 400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                     |
|:---|:---|:---|
| error_code | String | 调用失败时的错误码。 调用成功时无此字段。  |
| error_msg  | String | 调用失败时的错误信息。 调用成功时无此字段。 |
   
#### 请求示例
![](https://support.huaweicloud.com/api-sis/public_sys-resources/note_3.0-zh-cn.png)
"endpoint"即调用API的请求地址，不同服务不同区域的"endpoint"不同，具体请参见[终端节点](https://support.huaweicloud.com/api-sis/sis_03_0004.html)，当前支持上海一。
- 调用合成API，将文本合成为语音
  ```
  POST https://{endpoint}/v1/{project_id}/vcs/voices/clone
  Request Header:
  Content-Type: application/json 
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...    
    
  Request Body:
   { 
     "text": "欢迎使用语音云服务。",
     "config": 
     { 
       "audio_format": "wav", 
       "sample_rate": "24000", 
       "voice_name": "test_xiaoming"
     }
   }
  ```
  
  
#### 响应示例
**状态码：200**
成功响应示例
```
{ 
   "trace_id": "567e8537-a89c-13c3-a882-826321939651", 
   "result":{ 
     "data": "/+MgxAAUeHpMAUkQAANhuRACAIAgKHKQmRisVo0aNAgQIIQyCgGBiwfB8H4IAgCAJg+D4Ph+IAQBBywfB8HwQDGAwfB8Hwf..."
   } 
 }
```
**状态码：400**
失败响应示例
```
{  
    "error_code": "SIS.1207",  
    "error_msg": "'sample_rate' is invalid"  
 }
```