查询自定义提示音列表

查询自定义提示音列表。

请求 URL

GET {base_url}/{api_path}/custom_prompt/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 自定义提示音总数。
prompt_list Array<Custom_Prompt> 自定义提示音列表。
Custom_Prompt
参数 类型 说明
id Integer 自定义提示音的 ID。
file String 自定义提示音的文件名 (无文件拓展名)。
suffix String 文件拓展名 (如 ".wav")。
type String 自定义提示音类型。
  • tts：通过文本生成语音功能生成的自定义提示音。
  • record：通过分机录制或从本地上传的自定义提示音。
storage Integer 存储设备的 ID。
real_filename String 自定义提示音的文件名，包含文件扩展名 (如 "demo.wav")。
created_ts Integer 创建自定义提示音的时间戳 (秒)。
updated_ts Integer 更新自定义提示音的时间戳 (秒)。
asr_manufacturer String 文本转语音的服务提供商。
language String 文本转语音的语言代码。
voice_id String 文本转语音的发音人。
text String 通过文本转语音生成提示音所用的文本。
speed Integer 文本转语音的语速。
volume Integer 文本转语音的音量。
pitch Integer 文本转语音的音高。
extension String 录制提示音的分机号码。
path String 提示音在存储设备上的存储路径。

示例

请求示例

GET /openapi/v1.0/custom_prompt/list?access_token=YGQuUtZMCYJtcAd8mBBSNIC8tIcyXj2k&page=1&page_size=4 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 47,
    "prompt_list": [
        {
            "id": 56,
            "file": "vm_away-modified-by-feature-code.wav",
            "suffix": ".wav",
            "type": "record",
            "storage": 1,
            "created_ts": 1781072335,
            "updated_ts": 1788144083,
            "real_filename": "vm_away-modified-by-feature-code.wav"
        },
        {
            "id": 55,
            "file": "BusyNow-modified-by-feature-code",
            "suffix": ".wav",
            "type": "tts",
            "storage": 1,
            "created_ts": 1778556748,
            "updated_ts": 1788143938,
            "asr_manufacturer": "xunfei",
            "language": "zh-CN",
            "voice_id": "zh-CN_female_x4_panting",
            "text": "2222",
            "speed": 50,
            "volume": 50,
            "pitch": 50,
            "real_filename": "BusyNow-modified-by-feature-code.wav"
        },
        {
            "id": 54,
            "file": "tesppp99-modified-by-feature-code.wav",
            "suffix": ".wav",
            "type": "record",
            "storage": 1,
            "created_ts": 1778494904,
            "updated_ts": 1788144044,
            "real_filename": "tesppp99-modified-by-feature-code.wav"
        },
        {
            "id": 53,
            "file": "demo-modified",
            "suffix": ".wav",
            "type": "tts",
            "storage": 1,
            "created_ts": 1778494697,
            "updated_ts": 1788144128,
            "asr_manufacturer": "xunfei",
            "language": "zh-CN",
            "voice_id": "zh-CN_female_x4_panting",
            "text": "testtttt",
            "speed": 50,
            "volume": 50,
            "pitch": 50,
            "real_filename": "demo-modified.wav"
        }
    ]
}