JSON API » ringtones » ringtones/list

Returns the custom ringtones defined in /etc/enswitch/ringtones.ini.

Input parameters

Requires authentication and the residential, user, or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

A JSON object with the ringtone and its description in different languages as defined in /etc/enswitch/ringtones.ini.

Example: With required parameters

http://enswitch.example.com/api/json/ringtones/list/?auth_username=user;auth_password=password

{"responses":[{"message":"OK","code":"200","key":""}], "data":[{"value":"ring-tone-1","en":"Description in English for ringtone 1","fr":"Description en Français pour ringtone 1"},{"en":"Description in English for ringtone 2","value":"ring-tone-2","fr":"Description en Français pour ringtone 2"}]}

Change history

Version	Changes
4.4	Function added.