
# 依据文本生成TTS语音接口
#### 场景描述
智能助手平台提供接口给第三方接入方调用,实现文本生成TTS语音。
如果需要转换的文本内容较长时,则接口响应时间会对应的增加。
#### 接口方法
POST
#### 接口URI
https://IP:PORT/oifde/rest/api/tts/texttovoice
#### 消息头
Content-Type:application/json;charset=UTF-8
#### 请求说明
表1请求体参数 
| 序号 | 参数名       | 参数类型   | 是否必选 | 说明                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|:---|
| 1  | tenantId  | string | True | 租户ID。                                                                                                                                                                                                                                          |
| 2  | authToken | string | True | 认证token。 请参见[C3 智能助手平台接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0004.html#ZH-CN_TOPIC_0000002513073307)。            |
| 3  | text      | string | True | 待合成的文本内容,必须使用UTF-8编码。                                                                                                                                                                                                                          |
| 4  | config    | Object | True | 语音合成的配置信息。 该对象的参数说明请参见[表2]。 |
   
 表2config参数说明 
| 序号  | 参数名       | 参数类型   | 是否必选  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|:---|
| 4.1 | voiceName | String | True  | 模型特征串,服务器端利用此值来调用不同的模型。 目前支持的有： - cn_chengshuxing_common（成熟型）  - cn_kefuman_common（客服曼）  - cn_roumeiqian_common（柔美倩）  - cn_tianmeiru_common（甜美茹）  - cn_ziranzhen_common（自然真）   |
| 4.2 | pitch     | String | False | 基频,调节音调高低。 取值范围：-500\~500, 缺省:0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| 4.3 | volume    | String | False | 音量,调节音量大小。 取值范围：0\~100,缺省:50。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| 4.4 | speed     | String | False | 语速,调节语速快慢。 取值范围：-500\~500, 缺省:0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
   
#### 响应说明
- **响应状态码: 200**
  表3响应体参数 
  | 序号 | 参数名     | 参数类型   | 说明                                                                                                                                                                                                                                           |
  |:---|:---|:---|:---|
  | 1  | retCode | String | 0,成功,其他为失败。                                                                                                                                                                                                                                  |
  | 2  | retMsg  | String | 失败原因的描述。                                                                                                                                                                                                                                     |
  | 3  | data    | object | 返回结果。 该对象的参数说明请参见[表4]。 |
     
   表4data参数说明 
  | 序号  | 参数名        | 参数类型   | 说明                                                                                                                                                                                                                                             |
  |:---|:---|:---|:---|
  | 3.1 | format     | String | 音频编码格式。                                                                                                                                                                                                                                        |
  | 3.2 | sampleRate | int    | 音频采样率。                                                                                                                                                                                                                                         |
  | 3.3 | voiceData  | String | BASE64编码之后的音频数据。                                                                                                                                                                                                                               |
  | 3.4 | sentences  | List   | 输出的分句信息。 该对象的参数说明请参见[表5]。 |
     
   表5sentences参数说明 
  | 序号    | 参数名    | 参数类型 | 说明                     |
  |:---|:---|:---|:---|
  | 3.4.1 | st     | int  | 本句的开始时间戳,以ms为单位。       |
  | 3.4.2 | et     | int  | 本句的结束时间戳,以ms为单位。       |
  | 3.4.3 | offset | int  | 本分句在原始文本中的起始位置,以字节为单位。 |
  | 3.4.4 | len    | int  | 本分句在原始文本中的长度,以字节为单位。   |
     
  
- **响应状态码: 400**
  错误的请求：请检查请求路径及参数。
  
- **响应状态码: 401**
  未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
  
- **响应状态码: 404**
  请求的内容未找到：请检查请求的路径。
  
- **响应状态码: 500**
  业务失败：请依次确认您请求中各参数的取值。
  
 
#### 错误码
无。
#### 报文样例
请求消息头
```
Content-Type:application/json;charset=UTF-8
```
请求体消息
```
{
    "config": {
       "voiceName":"cn_tianmeiru_common"
    },
    "text":"你好,测试一下文本合成语音接口。",
    "authToken": "********************",
    "tenantId":"********************"
}
```
响应体消息
```
{
  "data": {
    "sentences": [
      {
        "st": 0,
        "offset": 0,
        "len": 48,
        "et": 2790
      }
    ],
    "voiceData": "UklGRuRsAQBXQVZFZm10IBA",
    "format": "wav",
    "sampleRate": "16000"
  },
  "retCode": "0"
}
```
