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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringTelephone line to get registrations for.Yes

Responses

CodeDescription
200Success.
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

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

VersionChanges
3.13Function added.