上传自定义提示音

上传自定义提示音。

请求 URL

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

请求参数

参数 是否必填 类型 说明
file 是 File 自定义提示音文件。
注： 仅支持 “.wav”、“.mp3” 或 “.gsm” 格式的文件，且文件大小不能超过 8MB。
is_check 否 String 操作模式。
注： 此参数仅当请求参数中未包含 old_file 和 new_file 时必填且有效。

取值范围：

  • ask：检查自定义提示音的文件名是否已存在。
  • force：上传自定义提示音文件。
    注： 如果不存在重复的文件名，直接添加自定义提示音；否则，覆盖已有文件。
old_file 否 String 要被替换的自定义提示音的文件名，包含文件扩展名 (如 "demo.wav")。
注：
  • 可使用 搜索自定义提示音 接口查询自定义提示音的文件名。
  • 仅允许输入通过分机录制的提示音 (type: record) 或通过文本转语音生成的提示音 (type: tts) 的文件名。
new_file 否 String 新文件名，用于替换原自定义提示音文件名，包含文件扩展名 (如 "demo.wav")。
注： 文件扩展名必须与旧文件相同。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
exist_type String 已存在的自定义提示音类型。
注： 如果该参数返回空字符，则表示不存在重复的文件名。
  • tts：通过文本生成语音功能生成的自定义提示音。
  • record：通过分机录制或从本地上传的自定义提示音。
upper_limited Integer 自定义提示音文件数量限制。
注： 此参数仅在自定义提示音文件数量达到限制时返回。

示例

请求示例

  • 检查自定义提示音文件 "demo.wav" 是否已存在。
    POST /openapi/v1.0/custom_prompt/upload?access_token=8MW5SHkimQ5XFufE93ErtTzKmNfc5UHp HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="/D:/prompt/demo.wav"
Content-Type: audio/wav

(binary data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="is_check"

ask
------WebKitFormBoundary7MA4YWxkTrZu0gW--
    图 1. Postman 请求示例 1
  • 上传自定义提示音文件 "demo.wav" 。
    POST /openapi/v1.0/custom_prompt/upload?access_token=8MW5SHkimQ5XFufE93ErtTzKmNfc5UHp HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="/D:/prompt/demo.wav"
Content-Type: audio/wav

(binary data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="is_check"

force
------WebKitFormBoundary7MA4YWxkTrZu0gW--
    图 2. Postman 请求示例 2

响应示例

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