JSON API » callergroups » callergroups/callers/list

Gets list of callers in a caller group.

Input parameters

Requires authentication and the system role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
callergroup	Integer	ID of caller group.	Yes

Responses

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

Data returned

http://enswitch.example.com/api/json/callergroups/callers/list/?auth_username=user;auth_password=password;callergroup=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data": [ { "called_prefix":"123", "called_min": 1, "called_max": 100, "description": "..." }, { "called_prefix":"345", "called_min": 1, "called_max": 100, "description": "..." }, ... ] }

Change history

Version	Changes
4.2	Function added.