JSON API » numbers » numbers/callers/list
Gets the fields of all caller routes for a number.
Input parameters
Requires authentication and the administrator, user, or wholesale role privileges.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| number | String | Number. | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The number does not exist, or you do not have permission to view it. |
Data returned
An array of fields, corresponding to the caller routes.
Example: With required parameters
http://enswitch.example.com/api/json/numbers/callers/list/?auth_username=user;auth_password=password;number=2125551234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "number":"2125551234", ... }, { "id":2, "number":"2125551234", ... } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |