JSON API » huntgroups » huntgroups/levels/set

Sets the fields of a hunt group level.

Input parameters

Requires authentication and the residential or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
huntgroup	Integer	ID of hunt group.	Yes
level	Integer	Level from 1 to 10.	Yes
music_ringing	Integer	1 to play music while ringing, 0 to play ringing, -2 to use hunt group default.	No	Current value.
play_message	Integer	1 to play the message file, 0 not to.	No	Current value.
ringtime	Integer	Time to ring each level in seconds. -2 to use hunt group default.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
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.
404	The hunt group does not exist, or you do not have permission to view it.

Data returned

No data is returned.

Example: Changing the ring time

http://enswitch.example.com/api/json/huntgroups/levels/set/?auth_username=user;auth_password=password;id=123;level=1;ringtime=30

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.