Vodia PBX API (version 58.0 and above)

This page includes all the API parameters of the page Admin > Settings > General > License. It contains the API information for the License page only.

License Page

GET License page's setting(s)

GET

1) (Info of License page at Admin > Settings > General Level)

rest/system/config

Success (200 OK)

Example:

Request:

curl -u username:password GET -D - http://192.168.1.194:8080/rest/system/license
{ key: "DAY-MAY-JAY-GGG", name: "Vodia PBX Hosted (chhajed ) DAY-MAY-JAY-GGG", expires: "Active subscription", status: "no_upgrade", remaining: "60", usage: " Domains: 3/1000, Calls: 0/250, G729A: 250, Extensions: 7/10000, Attendants: 6/10000, Callingcards: 1/10000, Hunt Groups: 2/10000, Paging Groups: 2/10000, Service Flags: 4/10000, IVR Nodes: 1/10000, Alerts: 0/0, Agent Groups: 3/10000, Conference Rooms: 1/10000, CO Lines: 1/10000, Adhoc Recording, CSTA, Lync Connectivity, CRM support, WebRTC support, Barge, Listen, Whisper, Trunk Accounting, Prepaid, Automatic Recording, Fax2Email", mplan: "Jan 1 2100", licensed: true, hosted: true, agreement: "20150925", type: "", company: "" }
Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.

UPDATE License page

post
/rest/system/license

Example:

Request:

curl -u username:password -D - http://localhost:8080/rest/system/license -X POST -d "{ 'key':'DAY-MAY-JAY-GGG' }"

Response for the Update request:

Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated a Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.