JSON API » huntgroups » huntgroups/destinations/create

Creates a new hunt group destination.

Input parameters

Requires authentication and the residential or user role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
huntgroupIntegerID of hunt group.Yes
levelIntegerLevel from 1 to 10.Yes
dtypeStringDestination type. "forward", "peer", "phone", or "sipuri".Yes
dnumberStringDestination number.Yes
append_calleridStringDigits to append to callerid.NoEmpty string.
availableInteger1 if destination is available, 0 if not.No1
screenInteger1 to play the callerid, 0 not to screen.No0
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.
404The hunt group does not exist, or you do not have permission to view it.

Data returned

The ID of the created hunt group destination.

Example: With required parameters

http://enswitch.example.com/api/json/huntgroups/destinations/create/?auth_username=user;auth_password=password;huntgroup=123;level=1;dtype=phone;dnumber=1234567

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

Change history

VersionChanges
3.13Function added.