JSON API » phones » phones/hardware/create
Creates hardware address for a telephone line.
Input parameters
Requires authentication and the phones role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
phone | Integer | Telephone line id. | Yes | |
hardware_address | String | Hardware address, such as MAC address. | Yes | |
provision1 | String | Special provisioning data. | No | Empty string. |
provisioning | Integer | ID of provisioning template. 0 for automatic or if provisioning is not enabled. | No | 0 |
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 telephone line does not exist, or you do not have permission to view it.. |
Data returned
Hardware address id.
Example: With required parameters
http://enswitch.example.com/api/json/phones/hardware/create/?auth_username=user;auth_password=password;id=55;hardware_address=aa:bb:cc:dd:ee:ff{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }
Change history
Version | Changes |
---|---|
4.3 | Function added. |