JSON API » subscriptions » subscriptions/list

Gets the fields of all subscriptions for a telephone line.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
snumber	String	Subscribing telephone line.	Yes
dtype	String	Monitored destination type. Empty string for all.	No	Empty string.
event	String	Subscription event package name. Empty string for all.	No	Empty string.

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 subscriptions table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/subscriptions/list/?auth_username=user;auth_password=password;stype=phone;snumber=1234567

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "snumber":"1234567", ... }, { "id":2, "snumber":"1234567", ... } ] }

Change history

Version	Changes
3.14	dtype input parameter changed default from "phone" to empty string. event input parameter changed default from "busy" to empty string.
3.13	Function added.