Licensing APIs

EndpointDescription
license/sites/:site/features/:feature-idCheck that a feature is available for the platform. The optional queue-id parameter checks that a feature is available for a specific queue.
license/sites/:site/features/:feature-id?queue=:queue-id
license/sites/:site/expiration-information

Returns the following license file information for the site:

  • Expiration date
  • User interface (UI) alert interval in days
  • Email notification interval in days
  • Email notification frequency in days
These endpoints return a true or false value to check that a feature is available.GET license/sites/:site/features/:feature-id The GET license/sites/:site/features/:feature-id endpoint checks the platform and returns a true only after the feature license is found.GET license/sites/:site/features/:feature-id?queue=:queue-id

The GET license/sites/:site/features/:feature-id?queue=:queue-id endpoint checks the platform and then the specified group for the feature license and returns a true only after the feature license is found AND it is enabled. The queue-id parameter is optional.Parameters

The request uses the following parameters:
ParameterRequired or OptionalDescriptionExample
siteRequiredThe site name configured on the Core instance.VHT
feature-idRequiredThe feature that is listed in the platform-features (with or without queue-id), license-features (with queue-id), or api-bandwidth (with queue-id) section of the license file.ptk, conversation-bridge, etc.
queue-idOptionalThe queue ID the request is submitted for.Sales
Example request

Sample request to check that a feature is available at the platform level of the system: license/sites/VHT/features/ptk

Example response

Sample response for feature availability at the platform level:
{    "id": "ptk","available": true}
Example request Sample request to check for a enabled feature at the license feature level for a specific queue: license/sites/VHT/features/agent-priority?queue=sales

Example response

Sample response for feature availability at the license feature level for a specific queue:
{    "id": "agent-priority","available": true}
Example request

Sample request to check for a enabled feature at the license feature level for a specific queue: license/sites/VHT/features/conversation-bridge?queue=marketingExample respons

Sample response for feature availability at the feature level for a specific queue:
{    "id": "conversation-bridge","available": true}
Error messages
Error codeDescription
404No data available for this site
503 Usage is outdated.
License file is expired.
License file is invalid or missing.
GET license/site/:site/expiration-information

Important: This API endpoint is available with VHT Callback software version 8.11.2 or later. The GET license/site/:site/expiration-information endpoint checks the license file. It returns the expiration date from the license file. It also returns other UI alert and email notification settings, in days, from the SystemVariables table in the VHT_Config database.Example request Sample request to return license file expiration and UI alert information for a site license/sites/VHT/expiration-informationExample response

Sample response for license file expiration and UI alert information.
{    "expiration-date":"2099-01-01T00:00:00Z","ui-notification-days":[30,60,90],    "email-notification-days":[1,7,30,60,90],"email-notification-frequency":1}
Error messages
Error codeDescription
404No data available for this site
503 Usage is outdated.
License file is expired.
License file expired on date.
License file is invalid or missing.