Download a Custom Ringtone

Retrieve the download resource URL of a specified custom ringtone, then access the URL to download the ringtone file.

Request URL

GET {base_url}/{api_path}/custom_ringtone/download?file={file}&type={type}&access_token={access_token}

Request parameters


Parameter	Required	Type	Description
file	Yes	String	The filename of the custom ringtone, including the file extension (e.g., "demo_ringtone.wav"). Note: You can query the filename of the custom ringtone using Search Custom Ringtones.
type	No	String	The type of the custom ringtone. Valid value: `built-in`: PBX built-in ringtone. `backend`: Ringtone uploaded from local storage.

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.
file	String	The filename of the custom ringtone.
download_resource_url	String	The download resource URL of the custom ringtone.

Example

Request example

GET /openapi/v1.0/custom_ringtone/download?file=Ring1.mp3&type=built-in&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "file": "Ring1.mp3",
  "download_resource_url": "/api/download/CustomRingtone-3xxxxxx7-download-20260914170440-rky1lVnu1qFbRdWh.mp3"
}

Combine the download resource URL with the {base_url}. Then use the complete link to download the ringtone file.

Download link format

{base_url}/{download_resource_url}

Download link example

https://yeastardocs.example.yeastarcloud.com/api/download/CustomRingtone-3xxxxxx7-download-20260914170440-rky1lVnu1qFbRdWh.mp3