JSON API » callergroups » callergroups/get

Gets the fields of a caller group.

Input parameters

Requires authentication and the system role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of caller group to get.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The caller group does not exist, or you do not have permission to view it.

Data returned

Fields of caller group.

Example: With required parameters

http://enswitch.example.com/api/json/callergroups/get/?auth_username=user;auth_password=password;id=123

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

Change history

VersionChanges
4.2Function added.