上传自定义铃声

上传自定义铃声。

请求 URL

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

请求参数

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

取值范围：

  • ask：检查自定义铃声的文件名是否已存在。
  • force：上传自定义铃声。
    注： 如果不存在重复的文件名，直接添加自定义铃声文件；否则，覆盖已有文件。
type 否 String 自定义铃声文件类型。
注： 此参数在添加自定义铃声文件而非覆盖文件时必填。

取值范围：

  • backend
old_file 否 String 要被替换的自定义铃声的文件名，包含文件扩展名 (如 "demo_ringtone.wav")。
注：
  • 可使用 搜索自定义铃声 接口查询自定义铃声的文件名。
  • 仅允许输入本地上传的自定义铃声 (type：backend) 的文件名。
new_file 否 String 新文件名，用于替换原自定义铃声的文件名，包含文件扩展名 (如 "demo_ringtone.wav")。
注： 文件扩展名必须与旧文件相同。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
upper_limited Integer 自定义铃声文件数量限制。
注： 此参数仅在自定义铃声文件数量达到限制时返回。

示例

请求示例

POST /openapi/v1.0/custom_ringtone/upload?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="demo_ringtone.wav"
Content-Type: audio/wav

<binary audio content>
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="is_check"

force
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="type"

backend
------WebKitFormBoundary7MA4YWxkTrZu0gW--
图 1. Postman 请求示例

响应示例

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