2202069(语音合成-V1.2.1)

接口信息

API Path
/aipass/aipassweb-api/application/lm/openApi/v1/largeModel/algorithm/2202069

请求协议
HTTPS

请求方法
POST

请求头部：

头部标签	必填	说明	类型	数据字典	限制	头部内容	示例
Content-Type	是	内容类型				application/json	application/json
X-APP-ID	是	买家中心-已购能力-【X-APP-ID】
Device-Uuid	是	设备管理-设备uuid
Authorization	是	鉴权信息

请求参数 Json
Object

参数名	说明	必填	类型	数据字典	限制	示例
req_id	请求全局唯⼀ ID，记录该值便于排查问题	是	[string]		0	请求全局唯⼀ ID，记录该值便于排查问题
text	待合成的⽂本，需要为 UTF-8 编码	是	[string]		0	待合成的⽂本，需要为 UTF-8 编码
ret_mode	合成音频的返回模式： 1：音频数据流（包括元数据），默认值 2：音频 URL（包括元数据 URL）	否	[int]		0	合成⾳频的返回模式，默认值1
format	音频编码格式，支持 PCM，WAV，MP3 格式，默认值：PCM	否	[string]		0	⾳频编码格式，⽀持 PCM，WAV 格式，默认值：PCM
sample_rate	音频采样率，支持 16000 Hz 和 8000 Hz，默认值：16000	否	[int]		0
voice	说话人，默认值：yixiaoling, 可支持 yixiaoling、yixiaotian、 yixiaoluo、yixiaotong、yixiaohui、yixiaoxuan、 yixiaochao、yixiaowei、 yixiaoliang、yixiaoshen、 yixiaojing、yixiaoke、yixiaorou、yixiaobei、yixiaoxin-female、yixiaoxin-male、yixiaobin、malili、tianxu、 yixiaoqing、yixiaoyao、yixiaoni、yixiaoting、yixiaoqi、 yixiaoqiong、yixiaolin、yixiaomeng、yixiaohan、yixiaoze、 yixiaohong、yixiaowan、yixiaotang、yixiaoping、 yixiaoyan、yixiaolan、yixiaotao、yixiaojun、yixiaolu、 yixiaohao、sarah、morgan、molly、clara、 elena、helen。 其中sarah、morgan、molly、clara、elena、helen 为纯英文 音色，不能说中文	否	[string]		0
volume	音量，取值范围：[0, 100]，默认值：50	否	[int]		0	⾳量，取值范围：[0, 100]，默认值：50
speech_rate	语速，取值范围：[0.5, 2.0]，默认值：1.0	否	[float]		0	语速，取值范围：[0.5, 2.0]，默认值：1.0
pitch	语调，取值范围：[0.5, 2.0]，默认值：1.0	否	[float]		0

响应内容：

返回结果

成功 (200)
Json
Object

参数名	说明	必填	类型	数据字典	限制	示例
code	状态码，⻅服务码说明	是	[int]		0
message	状态说明，⻅服务码说明	是	[string]		0
result	合成结果	是	[object]		0
result>>audio	合成音频数据，经过 base64 编码	是	[string]		0
result>>audio_len	合成音频长度，单位：ms	是	[int]		0
result>>phn_seq_len	合成音频音素序列长度	是	[int]		0
result>>phn_id_seq	合成音频音素 ID 序列	是	[array]		0
result>>phn_name_seq	合成音频音素名称序列	是	[array]		0
result>>phn_dur_seq	合成音频音素持续时间序列	是	[array]		0
result>>audio_url	合成音频文件地址，ret_mode为2时返回	是	[string]		0
result>>meta_url	元数据文件地址，ret_mode为2时返回	是	[string]		0

详细说明：

1、能力简介

• 离线语音合成，用于将待合成的文本转换为音频的场景。开发者需要保证在语音合成结果返回之前连接不中断；
• 支持输出格式：PCM，WAV，MP3 编码；
• 支持 8000 Hz，16000 Hz 采样率；
• 支持设置语速，音量；
• 支持设置多种说话人；
• 支持一次性合成 5000 字符以内的文字，其中 1 个汉字、1 个英文字母、1 个标点或 1 个句子中间空格均算作 1 个字符，超过 5000 个字符的内容将会截断；
• 仅支持采用 UTF-8 编码的文本输入；

2、修订历史

修订日期	算法版本号	修订内容
2025-12-19	V1.2.1	修复英文单词读法
2025-12-19	V1.2.0	接入天眼

3、服务鉴权

服务接口调用时需要严格遵循服务鉴权规则，服务调用鉴权规则请参见：开发指南 - 接口签名认证。

4、请求参数说明

HTTP 请求体传入的是输入参数组成的 JSON 格式的字符串，因此在 HTTP 请求头部的 Content-Type 必须设置为 application/json。输入参数如下表所示：

名称	类型	必需	说明
req_id	string	是	请求全局唯一 ID，记录该值便于排查问题，不可为空字符串
text	string	是	待合成的文本，需要为 UTF-8 编码，不可为空字符串
ret_mode	int	否	合成音频的返回模式：1：音频数据流（包括元数据），默认值2：音频 URL（包括元数据 URL）
format	string	否	音频编码格式，支持 PCM，WAV，MP3 格式，默认值：PCM
sample_rate	int	否	音频采样率，支持 16000 Hz 和 8000 Hz，默认值：16000
voice	string	否	说话人，默认值：yixiaoling, 可支持 yixiaoling、yixiaotian、yixiaoluo、yixiaotong、yixiaohui、yixiaoxuan、yixiaochao、yixiaowei、 yixiaoliang、yixiaoshen、yixiaojing、yixiaoke、yixiaorou、yixiaobei、yixiaoxin-female、yixiaoxin-male、yixiaobin、malili、tianxu、yixiaoqing、yixiaoyao、yixiaoni、yixiaoting、yixiaoqi、yixiaoqiong、yixiaolin、yixiaomeng、yixiaohan、yixiaoze、yixiaohong、yixiaowan、yixiaotang、yixiaoping、yixiaoyan、yixiaolan、yixiaotao、yixiaojun、yixiaolu、yixiaohao、sarah、morgan、molly、clara、 elena、helen。其中sarah、morgan、molly、clara、elena、helen 为纯英文音色，不能说中文
volume	int	否	音量，取值范围：[0, 100]，默认值：50
speech_rate	float	否	语速，取值范围：[0.5, 2.0]，默认值：1.0
pitch	float	否	语调，取值范围：[0.5, 2.0]，默认值：1.0

5、响应结果说明

提交合成请求后，服务端返回该请求的响应：

返回 HTTP 状态：200 表示成功，更多状态码请查阅 HTTP 状态码；输出参数：包含在响应的 Body 中，JSON 格式字符串：

名称	类型	说明
status	int	状态码，⻅服务码说明 (该字段即将下线)
status_msg	string	状态说明，⻅服务码说明 (该字段即将下线)
code	int	状态码，⻅服务码说明
message	string	状态说明，⻅服务码说明
result	object	合成结果
num_characters	int	字数统计

其中，单句结果 result 字段如下。

ret_mode == 1

名称	类型	说明
audio	string	合成音频数据，经过 base64 编码
audio_len	int	合成音频长度，单位：ms
phn_seq_len	int	合成音频音素序列长度
phn_id_seq	list	合成音频音素 ID 序列
phn_name_seq	list	合成音频音素名称序列
phn_dur_seq	list	合成音频音素持续时间序列

输出参数示例：

{
    "status": 10000,
    "status_msg": "Success",
    "code": 10000,
    "message": "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]
    },
    "num_characters": 6
}

ret_mode == 2

名称	类型	说明
audio_url	string	合成音频文件地址
meta_url	string	元数据文件地址

输出参数示例：

{
    "status": 10000,
    "status_msg": "Success",
    "code": 10000,
    "message": "Success",
    "result": {
        "audio_url": "https://gw.alipayobjects.com/os/bmw-prod/0574ee2e-f494-45a5-820f-63aee583045a.wav",
        "meta_url": "https://gw.alipayobjects.com/os/bmw-prod/0574ee2e-f494-45a5-820f-63aee583045a.json"
    },
    "num_characters": 6
}

6、请求示例

{
    "req_id": "test001",
    "text": "今天是周⼀，天⽓挺好的。"
}

7、状态码说明

状态码	解释	说明	解决方法
10301	Parameter error	参数错误	检查请求体是否符合接口协议
10302	Too many requests	并发请求过多	联系商务，增加并发
10304	Parse request body fail	请求格式错误	查看请求的 URL body 格式是否正确，参考接口文档
10401	Authorize fail	授权失败	联系技术人员
10503	Server connection time out	服务连接超时	联系技术人员
10903	Synthesis failed	合成失败	联系技术人员
10000	Success	成功	执行下一步操作

1、能力简介

• 离线语音合成，用于将待合成的文本转换为音频的场景。开发者需要保证在语音合成结果返回之前连接不中断；
• 支持输出格式：PCM，WAV，MP3 编码；
• 支持 8000 Hz，16000 Hz 采样率；
• 支持设置语速，音量；
• 支持设置多种说话人；
• 支持一次性合成 5000 字符以内的文字，其中 1 个汉字、1 个英文字母、1 个标点或 1 个句子中间空格均算作 1 个字符，超过 5000 个字符的内容将会截断；
• 仅支持采用 UTF-8 编码的文本输入；

2、修订历史

修订日期	算法版本号	修订内容
2025-12-19	V1.2.1	修复英文单词读法
2025-12-19	V1.2.0	接入天眼

3、服务鉴权

服务接口调用时需要严格遵循服务鉴权规则，服务调用鉴权规则请参见：开发指南 - 接口签名认证。

4、请求参数说明

HTTP 请求体传入的是输入参数组成的 JSON 格式的字符串，因此在 HTTP 请求头部的 Content-Type 必须设置为 application/json。输入参数如下表所示：

名称	类型	必需	说明
req_id	string	是	请求全局唯一 ID，记录该值便于排查问题，不可为空字符串
text	string	是	待合成的文本，需要为 UTF-8 编码，不可为空字符串
ret_mode	int	否	合成音频的返回模式： 1：音频数据流（包括元数据），默认值 2：音频 URL（包括元数据 URL）
format	string	否	音频编码格式，支持 PCM，WAV，MP3 格式，默认值：PCM
sample_rate	int	否	音频采样率，支持 16000 Hz 和 8000 Hz，默认值：16000
voice	string	否	说话人，默认值：yixiaoling, 可支持 yixiaoling、yixiaotian、yixiaoluo、yixiaotong、yixiaohui、yixiaoxuan、yixiaochao、yixiaowei、 yixiaoliang、yixiaoshen、yixiaojing、yixiaoke、yixiaorou、yixiaobei、yixiaoxin-female、yixiaoxin-male、yixiaobin、malili、tianxu、yixiaoqing、yixiaoyao、yixiaoni、yixiaoting、yixiaoqi、yixiaoqiong、yixiaolin、yixiaomeng、yixiaohan、yixiaoze、yixiaohong、yixiaowan、yixiaotang、yixiaoping、yixiaoyan、yixiaolan、yixiaotao、yixiaojun、yixiaolu、yixiaohao、sarah、morgan、molly、clara、 elena、helen。其中sarah、morgan、molly、clara、elena、helen 为纯英文音色，不能说中文
volume	int	否	音量，取值范围：[0, 100]，默认值：50
speech_rate	float	否	语速，取值范围：[0.5, 2.0]，默认值：1.0
pitch	float	否	语调，取值范围：[0.5, 2.0]，默认值：1.0

5、响应结果说明

提交合成请求后，服务端返回该请求的响应：

返回 HTTP 状态：200 表示成功，更多状态码请查阅 HTTP 状态码；输出参数：包含在响应的 Body 中，JSON 格式字符串：

名称	类型	说明
status	int	状态码，⻅服务码说明 (该字段即将下线)
status_msg	string	状态说明，⻅服务码说明 (该字段即将下线)
code	int	状态码，⻅服务码说明
message	string	状态说明，⻅服务码说明
result	object	合成结果
num_characters	int	字数统计

其中，单句结果 result 字段如下。

ret_mode == 1

名称	类型	说明
audio	string	合成音频数据，经过 base64 编码
audio_len	int	合成音频长度，单位：ms
phn_seq_len	int	合成音频音素序列长度
phn_id_seq	list	合成音频音素 ID 序列
phn_name_seq	list	合成音频音素名称序列
phn_dur_seq	list	合成音频音素持续时间序列

输出参数示例：

{
    "status": 10000,
    "status_msg": "Success",
    "code": 10000,
    "message": "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]
    },
    "num_characters": 6
}

ret_mode == 2

名称	类型	说明
audio_url	string	合成音频文件地址
meta_url	string	元数据文件地址

输出参数示例：

{
    "status": 10000,
    "status_msg": "Success",
    "code": 10000,
    "message": "Success",
    "result": {
        "audio_url": "https://gw.alipayobjects.com/os/bmw-prod/0574ee2e-f494-45a5-820f-63aee583045a.wav",
        "meta_url": "https://gw.alipayobjects.com/os/bmw-prod/0574ee2e-f494-45a5-820f-63aee583045a.json"
    },
    "num_characters": 6
}

6、请求示例

{
    "req_id": "test001",
    "text": "今天是周⼀，天⽓挺好的。"
}

7、状态码说明

状态码	解释	说明	解决方法
10301	Parameter error	参数错误	检查请求体是否符合接口协议
10302	Too many requests	并发请求过多	联系商务，增加并发
10304	Parse request body fail	请求格式错误	查看请求的 URL body 格式是否正确，参考接口文档
10401	Authorize fail	授权失败	联系技术人员
10503	Server connection time out	服务连接超时	联系技术人员
10903	Synthesis failed	合成失败	联系技术人员
10000	Success	成功	执行下一步操作