JSON API » numbers » numbers/system/get
Gets the system fields of a number.
Input parameters
Requires authentication and the system role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | No | None. |
| auth_password | String | Authentication password. | No | None. |
| number | String | Number to get. | 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. |
Data returned
Fields of number.
Example: With required parameters
http://enswitch.example.com/api/json/numbers/system/get/?auth_username=user;auth_password=password;number=2125551234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "number":"2125551234", "class":1, ... } }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |