JSON API » calleridgroups » calleridgroups/create

Creates a new callerid group, used for numbers to route some callers to alternative destinations.

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
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
name	String	Name.	Yes
description	String	Description.	Yes	Empty string.
shared	Integer	1 to share with all customers recursively, 0 not to. Only has effect with commerce role privilege.	No	0

Responses

Code	Description
200	Success.
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 callerid group.

Example: With required parameters

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

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

Change history

Version	Changes
4.3	Function added.