JSON API » phones » phones/reboot

Asks a telephone handset to reboot. Whether it does is up to the handset itself.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringTelephone line of handset.Yes

Responses

CodeDescription
204Success.
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 reboot it.

Data returned

No data is returned.

Example: With required parameters

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

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

Change history

VersionChanges
3.13Function added.