JSON API » phones » phones/unlock

Unlocks a telephone line if it has become locked because of too many incorrect passwords.

Input parameters

Requires authentication and the administrator, residential, user, or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Telephone line to unlock.	Yes

Responses

Code	Description
204	Success.
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 unlock it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/phones/unlock/?auth_username=user;auth_password=password;name=1234567

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.