JSON API » phones » phones/hardware/create

Creates hardware address for a telephone line.

Input parameters

Requires authentication and the phones role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
phoneIntegerTelephone line id.Yes
hardware_addressStringHardware address, such as MAC address.Yes
provision1StringSpecial provisioning data.NoEmpty string.
provisioningIntegerID of provisioning template. 0 for automatic or if provisioning is not enabled.No0

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
4.3Function added.