编辑自定义提示音

编辑通过文本转语音生成的自定义提示音。

请求 URL

POST {base_url}/{api_path}/custom_prompt/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 自定义提示音的 ID。
注: 可使用 搜索自定义提示音 接口查询自定义提示音的 ID。
file 否 String 自定义提示音的文件名。
注:
  • 文件名不能包含文件扩展名、空格,以及特殊字符 ' " ! : @ # $ % ^ * . & ( ) { } [ ] ; / , `。
  • 最大字符长度为 250。
text 否 String 用于生成自定义提示音的文本。
注:
  • 最大字符长度为 1000。
  • 文本语言必须与 language 中设置的语言相同。
language 否 String 文本转语音使用的语言的代码 (如 "en-US" 或 "zh-CN")。
注: 对应的语言必须为 asr_manufacturer 中设置的服务提供商支持的语言。
asr_manufacturer 否 String 文本转语音的服务提供商。
取值范围:
  • aws
  • xunfei
voice_id 否 String 发音人的 ID。
speed 否 Integer 语速。
注: 允许输入 1 到 100 之间的数字。
volume 否 Integer 音量。
注: 允许输入 1 到 100 之间的数字。
pitch 否 Integer 音高。
注: 允许输入 1 到 100 之间的数字。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。

示例

请求示例

POST /openapi/v1.0/custom_prompt/update?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "id": 37,
  "file": "doc_demo_prompt_v2"
}

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS"
}