JSON API » calleridgroups » calleridgroups/callers/list

Gets list of callers in a callerid group.

Input parameters

Requires authentication and the administrator role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
calleridgroup	Integer	ID of callerid group.	Yes
count	Integer	1 to return a count, 0 to return full data.	No	0
descending	Integer	1 to sort descending, 0 not to.	No	0
offset	Integer	The result to start at. 0 for the first.	No	0
pages	Integer	1 to return a reduced set of data for generating the pages select box, 0 to return full data.	No	0
sort	String	Field to sort by. "caller_prefix" or "description".	No	"caller_prefix"

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.
404	The callerid group does not exist, or you do not have permission to view it.

Data returned

http://enswitch.example.com/api/json/calleridgroups/callers/list/?auth_username=user;auth_password=password;calleridgroup=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.3	Function added.