非实时超自然语音合成(普通话)(算法编码:8000200002)
协议类型:HTTP
请求方法:POST
一、接入点
| 环境 |
地址 |
| 公网 |
https://api-maas.teleai.com.cn/aipaas/voice/v1/tts/supernatural |
- API Path :
/aipaas/voice/v1/tts/supernatural
- 请求方法 :
POST
- Content-Type :
application/json
二、鉴权
服务接口调用时需要严格遵循服务鉴权规则,采用请求头携带鉴权信息:
2.1 标准鉴权
Authorization: <鉴权信息>
| 请求头 |
必填 |
说明 |
Content-Type |
否 |
内容类型,固定 application/json |
X-APP-ID |
否 |
取值为控制台 → 应用及API Key → 创建应用 → AppID |
Device-Uuid |
否 |
设备uuid |
Authorization |
是 |
鉴权信息 |
2.2 Bearer Token 鉴权
Authorization: Bearer <用户申请的API-KEY>
| 请求头 |
必填 |
说明 |
Content-Type |
否 |
内容类型,固定 application/json |
Device-Uuid |
否 |
设备uuid |
Authorization |
是 |
Bearer <API_KEY> |
三、能力简介
离线语音合成,用于将待合成的文本转换为音频的场景。
四、请求与响应
4.1 请求参数
请求报文为 Json Object:
| 字段 |
类型 |
必填 |
说明 |
req_id |
string |
否 |
请求 ID,记录该值便于排查问题 |
text |
string |
是 |
待合成的文本,需要为 UTF-8 编码 |
ret_mode |
int |
否 |
合成音频的返回模式,1:音频数据流 |
format |
string |
否 |
音频编码格式,支持 PCM、WAV 格式,默认值:PCM |
voice |
string |
否 |
说话人,支持 cixingnan(磁性男)、songchinan(松弛男)、surennan(素人男)、cixingnan2(低音男)、zhubonan(主播男)、kefunan(客服男)、zhuchinan(主持男)、jilunan2(记录男)、surennv(素人女)、xianliaonv(闲聊女)、mansunv(慢速女)、kefunv1(主持女)、huoponv(活泼女)、ruyanv(典雅女)、xinwennv(新闻女)、kefunv2(客服女)、luolinv(萝莉女童)、huoponv2(活泼女童) |
volume |
int |
否 |
音量,取值范围:[0, 100],默认值:50 |
4.2 响应体
4.2.1 顶层字段
| 字段 |
类型 |
必填 |
说明 |
status |
int |
是 |
状态码,见服务码说明 |
status_msg |
string |
是 |
状态说明,见服务码说明 |
result |
object |
是 |
合成结果 |
4.2.2 合成结果 result
| 字段 |
类型 |
必填 |
说明 |
audio |
string |
是 |
合成音频数据,经过 base64 编码 |
audio_len |
int |
是 |
合成音频长度,单位:ms |
4.2.3 成功示例(Mock API)
{
"status": 10000,
"status_msg": "Success",
"result": {
"audio": "//6YYmNiDlSUXjZlDP8yADQAQ1E2ANKJOaTqFGUgIwDQAKAA==",
"audio_len": 2500,
"phn_seq_len": 10,
"phn_id_seq": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
"phn_name_seq": ["j", "in1", "t", "ian1", "z", "en3", "m", "e1", "l", "e5"],
"phn_dur_seq": [150, 350, 150, 350, 150, 350, 150, 350, 150, 350]
}
}
五、请求示例
{
"timestamp": 1673493479,
"req_id": "test001",
"text": "今天是周一,天气挺好的。"
}
六、状态码说明
6.1 算法状态码
| 状态码 |
说明 |
描述 |
解决方法 |
10000 |
Success |
成功 |
执行下一步操作 |
10301 |
Required parameter miss |
参数错误 |
检查请求体是否符合接口协议 |
10302 |
Too many requests |
并发请求过多 |
联系商务,增加并发 |
10304 |
Parse request body fail |
请求格式错误 |
查看请求的 URL body 格式是否正确,参考接口文档 |
10401 |
Authorize fail |
授权失败 |
联系技术人员 |
10503 |
Server connection time out |
服务连接超时 |
联系技术人员 |
10903 |
Recognize failed |
识别失败 |
联系技术人员 |
6.2 公共状态码
- 接口响应的公共状态码由网关统一定义,一般用于标识鉴权失败、限流或服务异常,具体业务错误码、错误信息及排查建议请参考:开发指南-公共信息及状态码。
七、调用示例
Python
import json
import time
import requests
import warnings
from datetime import datetime
import logging
# 配置日志,设置日志级别为INFO,并指定日志格式
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
# 配置环境变量
X_APP_ID = "yourAppId"
AUTHORIZATION = "yourAuthorization"
# URL 和请求数据
url = "https://api-maas.teleai.com.cn/aipaas/voice/v1/tts/supernatural"
request_data = {
"timestamp": int(time.time()),
"req_id": "test001",
"text": "今天是周一,天气挺好的。"
}
# 构建请求头
headers = {
"Content-Type": "application/json",
"X-APP-ID": X_APP_ID,
"Authorization": AUTHORIZATION
}
def timeSimple(timestamp):
# 将时间戳转换为HH:MM:SS格式的时间字符串
dt_object = datetime.fromtimestamp(timestamp)
formatted_time = dt_object.strftime("%H:%M:%S")
return formatted_time
def send_request(url):
try:
start_time = time.time()
logging.info(f"请求路径: {url}")
logging.info(f"开始发送: {timeSimple(start_time)}")
with requests.post(
url, json=request_data, headers=headers, stream=True, verify=False
) as response:
first_packet_time = None
if response.status_code == 200:
logging.info(f"接受到返回: {timeSimple(time.time())}")
for chunk in response.iter_content(chunk_size=1024):
if chunk:
if first_packet_time is None:
first_packet_time = time.time()
logging.info(
f"Received chunk: {timeSimple(time.time())} {chunk.decode('utf-8')}"
)
end_time = time.time()
logging.info(f"Time to first byte (TTFB): {first_packet_time - start_time:.3f} seconds")
logging.info(f"Request completed in {end_time - start_time:.3f} seconds")
else:
logging.error(f"Request failed with status code {response.status_code}")
except Exception as e:
logging.error(f"An error occurred: {e}")
# 发送请求
send_request(url)
logging.info(f"headers = {headers}")
Java(使用 Hutool)
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.json.JSONUtil;
import java.util.HashMap;
import java.util.Map;
/** 主类,用于发起HTTP请求并处理响应 */
public class Example {
public static void main(String[] args) {
example();
}
/**
* 方法中使用到的 JSONUtil、HttpRequest、HttpResponse均来自Hutool工具类。
* 具体maven依赖为:
* <dependency>
* <groupId>cn.hutool</groupId>
* <artifactId>hutool-all</artifactId>
* <version>5.8.29</version>
* </dependency>
*/
public static void example() {
try {
String url = "https://api-maas.teleai.com.cn/aipaas/voice/v1/tts/supernatural";
// 设置请求头
Map headers = new HashMap();
// 调用鉴权
headers.put("Content-Type", "application/json");
headers.put("X-APP-ID", "yourAppId");
headers.put("Authorization", "yourAuthorization");
// 创建请求对象
Map request = new HashMap();
request.put("timestamp", System.currentTimeMillis());
request.put("req_id", "test001");
request.put("text", "今天是周一,天气挺好的。");
// 将请求对象转换为JsonNode
String requestString = JSONUtil.toJsonStr(request);
// 发起HTTP请求
HttpResponse response =
HttpRequest.post(url)
.headerMap(headers, true)
.body(requestString)
.execute();
// 输出响应结果
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}