JSON API » music » music/create

Creates a new music class.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
class	String	If type=system, the class on musiconhold.conf.	No	Empty string.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
shared	Integer	1 to share with all customers on the system, 0 not to. Only has effect if system owner.	No	0
sort	String	"random" to play music files randomly, empty string to play linearly.	No	Empty string.
type	String	"user" for user configured, "system" for configured in Asterisk's musiconhold.conf.	No	"user"
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.

Data returned

The ID of the created music class.

Example: With required parameters

http://enswitch.example.com/api/json/music/create/?auth_username=user;auth_password=password;name=example

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.