语音合成接口

更新时间：2024-11-28

接口说明

接口鉴权和通用字段说明请查阅：接口通用说明

异步任务方式合成语音音频，同步接口和流式接口暂不开放。音频合成需要购买【交互组件-语音合成】组件，操作参考：平台操作指引

POST /api/digitalhuman/open/v1/tts/text2audio/submit

Content-Type: application/json;charset=utf-8

参数	类型	必填	说明
text	string	是	字符长度不超过 2000。支持 SSML 标签，使用说明见SSML使用说明
person	string	是	发音人ID，可用发音人列表参考：公共音色库，或克隆自有音色：音色克隆和查询接口
speed	int	否	语速：5是正常值，0-15的取值范围。越大语速越快，默认值5
volume	int	否	音量：5是正常值，0-15的取值范围，越大音量越大，默认值5
pitch	int	否	音调：5是正常值，0-15的取值范围。越大音调越高，默认值5
outputFormat	string	否	音频输出格式，支持mp3和wav，默认mp3
sampleRate	int	否	输出音频的每秒采样次数，目前只支持16000
callbackUrl	string	否	接口调用方接受任务回调通知的url，规则和接口说明参考任务回调说明，回调消息字段见下面回调参数表格。

参数	类型	说明
taskId	string	任务ID，用于调用任务查询接口查询任务状态

参数名	类型	是否必填	描述
taskId	string	是	任务ID
status	string	是	状态： SUCCESS（合成成功） FAILED（合成失败）
failedCode	int	否	失败错误码
failedMessage	string	否	失败错误信息
audioUrl	string	否	音频文件地址，文件会保存 7 天
duration	int	否	音频时长，单位 ms
textTimestamp	Array<Sentence>	是	文本时间戳信息
-- content	string	是	拆分的句子内容
-- startTimestamp	long	是	句子开始时间戳，单位毫秒（ms）
-- endTimestamp	long	是	句子结束时间戳，单位毫秒（ms）

GET /api/digitalhuman/open/v1/tts/text2audio/task

参数	类型	必填	说明
taskId	string	是	任务ID

参数	类型	必填	说明
status	string	是	状态： SUBMIT（已提交待合成） GENERATING（合成中） SUCCESS（合成成功） FAILED（合成失败）
failedCode	int	否	失败错误码，具体见下面表格
failedMessage	string	否	失败错误信息
audioUrl	string	否	音频文件地址，文件会保存 7 天
duration	int	否	音频时长，单位 ms
textTimestamp	Array<Sentence>	是	文本时间戳信息
-- content	string	是	拆分的句子内容
-- startTimestamp	long	是	句子开始时间戳，单位毫秒（ms）
-- endTimestam	long	是	句子结束时间戳，单位毫秒（ms）
createTime	string	是	创建时间，示例：2024-04-29T20:28:06
updateTime	string	是	更新时间，示例：2024-04-29T20:28:06

failedCode 说明