JSON API » huntgroups » huntgroups/destinations/create

Creates a new hunt group destination.

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
dtype	String	Destination type. "forward", "peer", "phone", or "sipuri".	Yes
dnumber	String	Destination number.	Yes
append_callerid	String	Digits to append to callerid.	No	Empty string.
available	Integer	1 if destination is available, 0 if not.	No	1
screen	Integer	1 to play the callerid, 0 not to screen.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0
description	String	Destination description.	No

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.
404	The 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

Version	Changes
4.2	description parameter added.
3.13	Function added.