JSON API » calleridgroups » calleridgroups/callers/get
Gets a caller 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 | |
id | Integer | ID of caller in a callerid group. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
Version | Changes |
---|---|
4.3 | Function added. |