JSON API » calleridgroups » calleridgroups/callers/get

Gets a caller in a callerid group.

Input parameters

Requires authentication and the administrator role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
calleridgroupIntegerID of callerid group.Yes
idIntegerID of caller in a callerid group.Yes

Responses

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

Data returned

http://enswitch.example.com/api/json/calleridgroups/callers/get/?auth_username=user;auth_password=password;calleridgroup=123;id=234

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

Change history

VersionChanges
4.3Function added.