Search Custom Ringtones

Search custom ringtones.

Request URL

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

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
search_value No String Search keyword.

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.
total_number Integer The total number of custom ringtones.
ringtone_list Array<Custom_Ringtone> The list of custom ringtones.
Custom_Ringtone
Parameter Type Description
id Integer The unique ID of the custom ringtone.
file String The filename of the custom ringtone.
suffix String The file extension of the custom ringtone.
  • .mp3
  • .wav
type String The type of the custom ringtone.
  • built-in: PBX built-in ringtone.
  • backend: Ringtone uploaded from local storage.

Example

Request example

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

Response example

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"
    }
  ]
}