User Services

In some cases it could be wanted to be able to configure the list of services that can be assigned via a client instead of using all the ones authorized.

This object allows an operator to defien such a list and then client can use it to filter the list of services returned by the standard licenses API.

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.

Listing available user services

GET /api/v1/configs/user_services/

Return the list of the user services configured.

Example request:

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

{
   "for_hg": true
}

Request JSON Object:

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

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

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

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

Example response:

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

{
   "user_services": [
      {
         "technical_name": "Basic Call Logs",
         "display_name": "Basic Call Logs",
         "description": "",
         "no_more_assignable": false
      }
   ]
}

Response JSON Object:

• user_services (array) – A list of user services. See User Service Attributes in List.

Status Codes:

• 200 OK – no error

Display user service instance

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

Retrieve information about the specified user service instance.

Example request:

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

Example response:

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

{
   "technical_name": "Basic Call Logs",
   "display_name": "Basic Call Logs",
   "description": "",
   "no_more_assignable": false,
   "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 user service, it’s identifier.

• display_name (string) – It’s a friendly name of the user service, to be displayed.

• description (string) – A description text.

• no_more_assignable (boolean) – Indicate if this user service should no more be used.

• for_hg (boolean) – This user service is available only for Hunt Groups”.

• for_cc (boolean) – This user service is available only for Call Centers”.

• for_ivr (boolean) – This user service is available only for IVR”.

• for_enduser (boolean) – This user service is available only for End Users”.

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

Status Codes:

• 200 OK – no error

• 404 Not Found – the user service is not found.

Local objects definition

User Service Attributes in List

Name	Type	Method	Description
		GET
technical_name	String	A	Primary identifier of the User Service.
display_name	String	A	User friendly display name of the User Service.
description	String	A	A description of the User Service.
no_more_assignable	Boolean	A	Indicate if this User Service should no more be used.