JSON API » phones » phones/emergency/url

Gets the emergency URL of a telephone line.

Input parameters

Requires authentication and the 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	Integer	Name of telephone line to get URL for.	Yes

Responses

Code	Description
200	Success.
204	Request successful, but no emergency URL configured.
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

URL to redirect users to where they can fill in the emergency address of the telephone line.

Example: With required parameters, and URL configured

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "url":"https://example.com/emergency/" } }

Example: With required parameters, but no URL configured

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

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

Change history

Version	Changes
3.13	Function added.