Virtual Services Packs

In some cases it could be wanted to use the notion of Services Packs even when it is not possible due to restriction of the Application Server.

It could be the case for Service users such as IVR if the notion of Services pack is not applicable to them.

The APIO has therefore introduced these new configuration objects called Virtual Services Packs.

What is proposed is to define a list of services that will be assigned individually and to designate one of these services as the reference service for counting services licenses.

It must be noted currently it is just configuration objects that can be read by a “client” in order that he can use them to drive its licenses management. It is not (yet) possible to use this notion in the assign of services and in the reading of licenses allocations.

This object allows also to restrict the usage of the virtual services pack to one or several type of service users.

Listing available virtual services packs

GET /api/v1/configs/virtual_service_packs/

Return the list of the virtual services packs configured.

Example request:

GET /api/v1/configs/virtual_service_packs/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "for_hg": true
}

Request JSON Object:

• for_hg (boolean) – If set only the virtual services packs flagged as “available for Hunt Groups” will be returned

• for_cc (boolean) – If set only the virtual services packs flagged as “available for Call Centers” will be returned

• for_ivr (boolean) – If set only the virtual services packs flagged as “available for IVR” will be returned

• for_enduser (boolean) – If set only the virtual services packs flagged as “available for End Users” will be returned

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "virtual_service_packs": [
      {
         "technical_name": "For_HG",
         "display_name": "Power Pack HG",
         "description": "",
         "reference_service": "Zone Calling Restrictions",
         "no_more_assignable": false
      }
   ]
}

Response JSON Object:

• virtual_service_packs (array) – A list of virtual services packs. See Virtual Services Pack Attributes in List.

Status Codes:

• 200 OK – no error

Display virtual services pack instance

GET /api/v1/configs/virtual_service_packs/(string: instance_name)/

Retrieve information about the specified virtual services pack instance.

Example request:

GET /api/v1/configs/virtual_service_packs/For_HG/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "technical_name": "For_HG",
   "display_name": "Power Pack HG",
   "description": "",
   "content": {
      "services": ["Authentication", "Basic Call Logs", "Call Forwarding Busy", "Call Forwarding No Answer", "Call Forwarding Not Reachable", "Zone Calling Restrictions"]
   },
   "no_more_assignable": false,
   "reference_service": "Zone Calling Restrictions",
   "for_hg": true,
   "for_ivr": false,
   "for_cc": false,
   "for_enduser": false,
   "add_data": {}
}

Response JSON Object:

• technical_name (string) – It’s the technical name of the virtual services pack, it’s identifier.

• display_name (string) – It’s a friendly name of the virtual services pack, to be displayed.

• description (string) – A description text.

• content (object) – An object containing one attribute services containing the list of services part of the virtual services pack.

• no_more_assignable (boolean) – Indicate if this virtual services pack should no more be used.

• reference_service (string) – The reference service part to be used for licenses count. It must be part of the services.

• for_hg (boolean) – This virtual services pack is available only for Hunt Groups”.

• for_cc (boolean) – This virtual services pack is available only for Call Centers”.

• for_ivr (boolean) – This virtual services pack is available only for IVR”.

• for_enduser (boolean) – This virtual services pack is available only for End Users”.

• add_data (object) – An object for future use.

Status Codes:

• 200 OK – no error

• 404 Not Found – the virtual services pack is not found.

Local objects definition

Virtual Services Pack Attributes in List

Name	Type	Method	Description
		GET
technical_name	String	A	Primary identifier of the Virtual Services Pack.
display_name	String	A	User friendly display name of the Virtual Services Pack.
description	String	A	A description of the Virtual Services Pack.
reference_service	String	A	The reference service part to be used for licenses count.
no_more_assignable	Boolean	A	Indicate if this Virtual Service Pack should no more be used.