JSON API » huntgroups » huntgroups/destinations/update

Updates an existing hunt group destination.

Input parameters

Requires authentication and the residential or user role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of hunt group destination to update.Yes
append_calleridStringDigits to append to callerid.NoCurrent value.
availableInteger1 if destination is available, 0 if not.NoCurrent value.
dtypeStringDestination type. "forward", "peer", "phone", or "sipuri".NoCurrent value.
dnumberStringDestination number.NoCurrent value.
levelIntegerLevel from 1 to 10.NoCurrent value.
screenInteger1 to play the callerid, 0 not to screen.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

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

Data returned

No data is returned.

Example: Changing the level

http://enswitch.example.com/api/json/huntgroups/destinations/update/?auth_username=user;auth_password=password;id=123;level=1

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

Change history

VersionChanges
3.13Function added.