JSON API » music » music/create

Creates a new music class.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
classStringIf type=system, the class on musiconhold.conf.NoEmpty string.
customerIntegerID of customer to create in.NoCustomer of authentication user.
descriptionStringDescription.NoEmpty string.
sharedInteger1 to share with all customers on the system, 0 not to. Only has effect if system owner.No0
sortString"random" to play music files randomly, empty string to play linearly.NoEmpty string.
typeString"user" for user configured, "system" for configured in Asterisk's musiconhold.conf.No"user"
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.13Function added.