播放自定义提示音

获取指定自定义提示音的播放资源 URL，然后访问该 URL 下载提示音并在本地播放。

请求 URL

GET {base_url}/{api_path}/custom_prompt/play?file={file}&access_token={access_token}

请求参数


参数	是否必填	类型	说明
file	是	String	自定义提示音的文件名，包含文件扩展名 (如 "welcome.wav")。注：可使用搜索自定义提示音接口查询自定义提示音的文件名。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
file	String	自定义提示音的文件名。
play_resource_url	String	自定义提示音的播放资源 URL。

示例

请求示例

GET /openapi/v1.0/custom_prompt/play?file=doc_demo_prompt.wav&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "file": "doc_demo_prompt.wav",
  "play_resource_url": "/api/download/CustomPrompt-3xxxxx7-download-20260914172717-wVBfNL7WIlYWSzPH.wav"
}

将播放资源 URL 与 {base_url} 组合，然后使用组合后的完整链接下载自定义提示音文件并在本地播放。

播放链接格式

{base_url}/{play_resource_url}

播放链接示例

https://yeastardocs.example.yeastarcloud.com/api/download/CustomPrompt-3xxxxx7-download-20260914165139-x7E92Gab952IwoXB.wav