JSON API » phones » phones/registrations/list

Gets the fields of all SIP registrations for a telephone line.

Input parameters

Requires authentication and the residential or user 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 get registrations for (empty for all).	No

Responses

Code	Description
200	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 view it.

Data returned

An array of fields, corresponding to the rows of the location table in the database.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "contact":"sip:user1@example.com", ... }, { "id":2, "contact":"sip:user2@example.com", ... } ] }

Change history

Version	Changes
4.3	name parameter is now optional.
3.13	Function added.