JSON API » ingroups » ingroups/create

Creates a new inbound group.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
bill_cards	Integer	1 to bill calling cards for inbound calls via this inbound group, 0 not to.	No	1
callerid	Integer	1 if this inbound group may be used as callerid, 0 if not.	No	1
callerid_location	Integer	1 if this inbound group may be used as location callerid, 0 if not. Has no effect unless location callerid is configured.	No	1
cnam_lookup	Integer	1 to perform CNAM lookups on calls to numbers. 0 not to.	No	0
code	String	Area code.	No	Empty string.
currency	String	Currency inbound call costs are in.	No	System currency.
description	String	Description.	No	Empty string.
included	Integer	1 if calls to this inbound group counts towards included call time, 0 if not.	No	0
minimum_pool	Integer	Minimum number of spare numbers. If fewer, system will topup using number vendors. 0 to disable.	No	0
name_invoices	String	Name as shown on invoices. Empty string to use name.	No	Empty string.
ported	Integer	ID of customer who may port numbers to this group. 0 for none. -1 for all.	No	0
signup	Integer	1 if this inbound group may be used in signup, 0 if not.	No	1
tags	String	Tags.	No	Empty string.
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.

Data returned

The ID of the created inbound group.

Example: With required parameters

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

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

Change history

Version	Changes
3.14	ported input parameter changed from 1 to allow to -1 to allow for all customers, or the ID of the allowed customer.
3.13	Function added.