搜索自定义铃声

请求 URL

GET {base_url}/{api_path}/custom_ringtone/search?page={page}&page_size={page_size}&search_value={search_value}&access_token={access_token}

请求参数


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

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
total_number	Integer	自定义铃声的总数。
ringtone_list	Array<Custom_Ringtone>	自定义铃声列表。

Custom_Ringtone


参数	类型	说明
id	Integer	自定义铃声的唯一 ID。
file	String	自定义铃声的文件名。
suffix	String	自定义铃声的文件扩展名。 `.mp3` `.wav`
type	String	自定义铃声的类型。 `built-in`：PBX 内置铃声。 `backend`：本地上传的自定义铃声。

示例

请求示例

GET /openapi/v1.0/custom_ringtone/search?page=1&page_size=5&search_value=Ring&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "total_number": 10,
  "ringtone_list": [
    {
      "id": 2,
      "file": "Ring1.mp3",
      "suffix": ".mp3",
      "type": "built-in"
    },
    {
      "id": 3,
      "file": "Ring2.mp3",
      "suffix": ".mp3",
      "type": "built-in"
    }
  ]
}