Edit a Custom Ringtone

Update the filename of a specified custom ringtone.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The ID of the custom ringtone.
Note: You can query the ID of the custom ringtone using Search Custom Ringtones.
new_file Yes String The new filename, including the file extension (e.g., "demo_ringtone.wav").

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Example

Request example

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

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "id": 12,
  "new_file": "demo_ringtone.wav"
}

Response example

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