JSON API » outgroups » outgroups/create

Creates a new outbound 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
callergroup	Integer	ID of caller group this inbound group will be restricted to, 0 for any caller.	No	0
description	String	Description.	No	Empty string.
included	Integer	1 if calls to this outbound group counts towards included call time, 0 if not.	No	0
name_invoices	String	Name as shown on invoices. Empty string to use name.	No	Empty string.
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 outbound group.

Example: With required parameters

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

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

Change history

Version	Changes
4.2	callergroup parameter added.
3.13	Function added.