JSON API » callergroups » callergroups/create

Creates a new caller group, used to price inbound calls differently for some callers.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
descriptionStringDescription.YesEmpty string.

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

The ID of the created caller group.

Example: With required parameters

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

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

Change history

VersionChanges
4.2Function added.