JSON API » huntgroups » huntgroups/create

Creates a new hunt group.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
allow_forwards	Integer	1 to allow destinations to forward calls, 0 not to.	No	0
anumber	String	Destination number if no destinations are available to be called.	No	"hangup"
atype	Integer	Destination type if no destinations are available to be called.	No	Empty string.
bnumber	String	Destination number if a destination returns "busy", and no destination returns "no answer".	No	"hangup"
btype	Integer	Destination type if a destination returns "busy", and no destination returns "no answer".	No	Empty string.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
dnumber	String	Destination number if no levels answer. This is the default exit number.	No	"hangup"
dtype	Integer	Destination type if no levels answer. This is the default exit type.	No	Empty string.
music	Integer	ID of music class to play. 0 for default.	No	0
music_ringing	Integer	1 to play music while ringing, 0 to play ringing.	No	0
owner	Integer	ID of owner. 0 for none.	No	0
panel	Integer	1 to show in control panel, 0 not to.	No	0
recordgroup	Integer	ID of record group. 0 for none.	No	0
ringtime	Integer	Time to ring each level in seconds. May be overridden per level.	No	10
screen	Integer	1 to play the callerid, 2 to ask the caller to record their name, 0 not to screen.	No	0
type	String	Type of hunt group. "circular", "linear", "smart_circular", or "smart_linear".	No	"linear"
validation	Integer	1 to validate input then return, 0 for full action.	No	0

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.

Data returned

The ID of the created hunt group.

Example: With required parameters

http://enswitch.example.com/api/json/huntgroups/create/?auth_username=user;auth_password=password;name=example

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

Change history

Version	Changes
4.1	anumber, atype, bnumber, and btype parameters added.
3.13	Function added.