本接口用于将提供的文本内容转换成高质量的语音音频文件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:SubmitAudioProduceJob | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
EditingConfig | string | 是 | 音频生产配置:
| {"voice":"Siqi","format":"MP3","volume":50} |
OutputConfig | string | 是 | 音频输出配置 | 例如将输出的语音存至:http://my_bucket.oss-cn-shanghai.aliyuncs.com/target_audio.mp3,则此参数配置为: { "bucket": "my_bucket", "object": "target_audio" } |
InputConfig | string | 是 | 文本内容,最大支持 10000 个汉字。支持 SSML 标记语言。 | 测试文本 |
Title | string | 否 | 任务标题。若不提供,根据日期自动生成默认 title
| 任务标题。 若不提供,根据日期自动生成默认title 长度不超过128字节 UTF8编码 |
Description | string | 否 | 任务描述:
| 任务描述长度不超过1024字节 UTF8编码 |
UserData | string | 否 | 自定义设置,Json 格式,长度限制为 512 字节。支持自定义回调地址配置。 | {"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"} |
Overwrite | boolean | 否 | 是否覆盖现有 OSS 文件。 | true |
返回参数
智能语音任务执行结果可以用智能语音任务 JobId 通过获取智能任务结果接口查询任务执行详细信息,任务执行成功时获取智能任务结果接口返回结果示例如下。
{
"RequestId": "******2D-443C-5043-B0E4-867070******",
"JobId": "******042d5e4db6866f6289d1******",
"State": "Finished",
"SmartJobInfo": {
"Title": "default_title_2022-01-21T06:15:07Z",
"JobType": "TextToSpeech",
"CreateTime": "2022-01-21T06:15:07Z",
"ModifiedTime": "2022-01-21T06:15:07Z",
"InputConfig": {
"InputFile": "提起郭德纲,现在可以说是红的发紫了,常常票价很高,但是一开手就被疯抢一空,还参加各种相声综艺节目点评新人表演演员已经"
},
"EditingConfig": "{\"format\":\"MP3\",\"pitch_rate\":0,\"sample_rate\":16000,\"speech_rate\":0,\"voice\":\"Siqi\",\"volume\":50}",
"OutputConfig": {
"Bucket": "your-bucket",
"Object": "your-audio"
}
},
"JobResult": {
"MediaId": "******bf47c94e82b3b2014361******",
"AiResult": "[{\"text\":\"提起\",\"begin_time\":0,\"end_time\":846},{\"text\":\"现在可以说是红的发紫了\",\"begin_time\":846,\"end_time\":3386},{\"text\":\"常常票价很高\",\"begin_time\":3386,\"end_time\":4402},{\"text\":\"但是一开手就被疯抢一空\",\"begin_time\":4402,\"end_time\":6265},{\"text\":\"还参加各种相声综艺节目点评新人表演演员已经\",\"begin_time\":6265,\"end_time\":10330}]"
}
}
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****",
"State": "Created",
"MediaId": "****2bcbfcfa30fccb36f72dca22****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-04-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |