[Index]

API Reference for view/QuickSubscriberForMsTeamsMultiVendor

NB! This 'QuickSubscriberForMsTeamsMultiVendor' view model will (eventually) be deprecated. Please re-integrate / start using 'HybridMultiVendorVIEW' instead. **Multi Vendor Quick Add Subscriber** provides a single page where you can: * Add or Remove Microsoft Direct Routing for a User * Assign a Microsoft Licence that allows Enterprise Voice to be Enabled * Change the Directory Number and Associated E164 for the users Teams Client * Change the Users Service Type * Update the Users Entitlement Profile * Update the Class of Service for the Users Teams Client **User Provisioning** 1. Select a User from the username dropdown. This will show a list of users that have already been synced to VOSS Automate via LDAP. This could either be via Top Down or Bottom up syncing. For provisioning to be successful the device.cucm.UserIdentity field should match the UPN of the user in O365(MsolUser). If the user already has cisco services these will be displayed in the "User Status & Existing Services" section 2. A Directory Number can be selected. If Cisco services exists the users 1st line will be displayed. 3. The required Service Type should be selected. For more information see the Service Type descriptions. 4. If displayed the Entitlement Profile can be changed. If the Entitlement Profile is configured in the Service Type this field will be hidden. 5. A Quick Add Group can be selected to configure settings on the Teams user based on data.LyncQuickAddGroups-Teams. Otherwise Values will use the Microsoft Site Defaults **Service Types** * Cisco-Only-E164 - User has only Cisco Devices with an associated E164 Number. Teams user is not Enabled for Enterprise Voice. There is no routing between Cisco and Teams for this User. * Cisco-MS-E164 - User has both Cisco Devices and a Teams Device with an associated E164 number. A SNR profile is used on the Cisco User to fork calls to the Teams Client. E164 Number can be shared across all devices. * MS-Only-E164 - User has only a Teams Device with an associated E164 Number. All Cisco Devices and Services will be deleted. * CiscoSubscriber-No-Services-E164 - All Cisco and Teams devices will be removed from the user. * Cisco-Only-IntExtn - User has only Cisco Devices with no associated E164. Teams user is not Enabled for Enterprise Voice. There is no routing between Cisco and Teams for this User. * Cisco-MS-IntExtn - User has both Cisco Devices and a Teams Device with no associated E164. A SNR profile is used on the Cisco User to fork calls to the Teams Client. A dummy E164 number (+888SLC+EXT) is generated to allow cross platform routing. * MS-Only-IntExtn - User has only a Teams Device with no associated E164. All Cisco Devices and Services will be deleted.A dummy E164 number (+888SLC+EXT) is generated to allow cross platform routing. * CiscoSubscriber-No-Services-IntExtn - All Cisco and Teams devices will be removed from the user. **Teams Licences** The MVS_QaS Workflow will check that the O365 user has an assigned license that has Entprise Voice capabalities. If a valid license is not found the workflow will fail. Alternatively it's possible for VOSS Automate to assign a valid license to the User. After assigning the license it may take some time for the change to appear on the Tenant, this is due to propogation delay in the Microsoft Cloud. The user will be marked as "Microsoft Update Pending", VOSS Automate will periodically check for this user in the Teams Tenant, once the User has appeared VOSS Automate will complete the configuration steps

Model ref.: view/QuickSubscriberForMsTeamsMultiVendor

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/QuickSubscriberForMsTeamsMultiVendor/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "custom_string_6": {
               "type": "string", 
               "title": "custom_string_6"
          }, 
          "ms_teams": {
               "type": "boolean", 
               "title": "Microsoft Teams"
          }, 
          "custom_string_8": {
               "type": "string", 
               "title": "custom_string_8"
          }, 
          "directoryUri": {
               "required": false, 
               "type": "string", 
               "title": "Directory URI"
          }, 
          "pin": {
               "required": false, 
               "is_password": true, 
               "type": "string", 
               "description": "The corresponding CUCM and CUC user PIN will be set with this PIN", 
               "title": "PIN"
          }, 
          "homeNumber": {
               "required": false, 
               "type": "string", 
               "title": "Home Number"
          }, 
          "custom_boolean_10": {
               "type": "boolean", 
               "title": "custom_boolean_10"
          }, 
          "existing": {
               "type": "object", 
               "properties": {
                    "cucm_user_identity": {
                         "type": "string", 
                         "title": "CUCM User Identity / AD UserPrincipalName"
                    }, 
                    "teamsTelephonyLicense": {
                         "type": "string", 
                         "title": "MS Teams Telephony License"
                    }, 
                    "contact_center": {
                         "type": "string", 
                         "title": "Contact Center"
                    }, 
                    "ext_mobilities": {
                         "type": "string", 
                         "title": "Extension Mobility Profiles"
                    }, 
                    "phones": {
                         "type": "string", 
                         "title": "Phones"
                    }, 
                    "voicemail": {
                         "type": "string", 
                         "title": "Voicemail Extension"
                    }, 
                    "snr": {
                         "type": "string", 
                         "title": "Single Number Reach"
                    }, 
                    "teams_line_uri": {
                         "type": "string", 
                         "title": "Teams Line URI"
                    }, 
                    "UserType": {
                         "type": "string", 
                         "title": "User Type"
                    }, 
                    "webex": {
                         "type": "string", 
                         "title": "WebEx"
                    }, 
                    "teamsTelephonyAllowed": {
                         "type": "boolean", 
                         "title": "Licence for MS Teams Telephony Available"
                    }, 
                    "teams_msol_upn": {
                         "type": "string", 
                         "title": "MS Teams UserPrincipalName"
                    }, 
                    "cucm_user_ldapDirectoryName": {
                         "type": "string", 
                         "title": "CUCM User LDAP Directory Name"
                    }, 
                    "spark": {
                         "type": "string", 
                         "title": "Webex Teams"
                    }, 
                    "teams_licenses": {
                         "items": {
                              "type": "object", 
                              "properties": {
                                   "AccountSkuId": {
                                        "type": "string", 
                                        "title": "AccountSkuId"
                                   }, 
                                   "Name": {
                                        "type": "string", 
                                        "title": "Name"
                                   }
                              }
                         }, 
                         "type": "array", 
                         "title": "Teams Licenses"
                    }
               }, 
               "title": "User Status & Existing Services"
          }, 
          "manager": {
               "required": false, 
               "type": "string", 
               "title": "Manager"
          }, 
          "MultiVendorServiceType": {
               "required": true, 
               "type": "string", 
               "description": "Select the required Service Type for the user. The Service Type defines the collection of settings that will be applied to Teams and CUCM to achieve different behaviours. Appropriate Service Types will be shown based on whether the selected line has an associated E164 number.", 
               "title": "Service Type"
          }, 
          "cucm_user": {
               "type": "string", 
               "title": "CUCM User"
          }, 
          "forceEp": {
               "type": "string", 
               "title": "Use Entitlement from Service Definition"
          }, 
          "user_status": {
               "type": "string", 
               "title": "User status"
          }, 
          "lookUpForUser": {
               "type": "boolean", 
               "description": "Includes users above site level when searching", 
               "title": "Include users at higher hierarchy"
          }, 
          "line1DN": {
               "required": false, 
               "type": "string", 
               "description": "Select line and associated E164 to configure in Teams.Value will default to users first line in CUCM. If line does not have an associated E164, a dummy E164 number will be generated.", 
               "title": "Directory Number"
          }, 
          "title": {
               "required": false, 
               "type": "string", 
               "title": "Title"
          }, 
          "forceQag": {
               "type": "string", 
               "title": "Use QAG from Service Definition"
          }, 
          "entitlement_profile": {
               "required": false, 
               "type": "string", 
               "description": "If Entitlement Profiles are used on the platform they can be selected or changed here. If the Entitlement profile is configured within a Service Type this field will be hidden.The field will initially display the default Entitlement Profile", 
               "title": "Entitlement Profile"
          }, 
          "displayLine1CoS": {
               "type": "boolean", 
               "title": "Display Line 1 CoS"
          }, 
          "department": {
               "required": false, 
               "type": "string", 
               "title": "Department"
          }, 
          "cucm_user_ldapDirectoryName": {
               "type": "string", 
               "title": "CUCM User LDAP Directory Name"
          }, 
          "email": {
               "pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$", 
               "type": "string", 
               "format": "email", 
               "required": false, 
               "title": "Email Address"
          }, 
          "line1E164": {
               "required": false, 
               "type": "string", 
               "title": "E164 Number"
          }, 
          "username": {
               "required": true, 
               "type": "string", 
               "description": "VOSS Automate username as per data.User", 
               "title": "Username"
          }, 
          "custom_string_9": {
               "type": "string", 
               "title": "custom_string_9"
          }, 
          "firstname": {
               "required": false, 
               "type": "string", 
               "title": "First Name"
          }, 
          "isCucmUserPresent": {
               "default": "false", 
               "type": "boolean", 
               "title": "Is CUCM User Present"
          }, 
          "lastname": {
               "required": false, 
               "type": "string", 
               "title": "Last Name"
          }, 
          "custom_string_10": {
               "type": "string", 
               "title": "custom_string_10"
          }, 
          "failIfNotFound": {
               "type": "boolean", 
               "description": "used with API to prevent creation of local users where LDAP is in use", 
               "title": "Fail Transaction if user not found"
          }, 
          "msol_user": {
               "type": "string", 
               "title": "MSOL User"
          }, 
          "password": {
               "required": false, 
               "is_password": true, 
               "type": "string", 
               "description": "The corresponding CUCM, CUC and WebEx user password will be set with this password", 
               "title": "Password"
          }, 
          "forceMsTeams": {
               "type": "string", 
               "title": "Use MS Teams from Service Definition"
          }, 
          "ldap_user": {
               "type": "string", 
               "title": "LDAP User"
          }, 
          "data_user": {
               "type": "string", 
               "title": "Data User"
          }, 
          "telephoneNumber": {
               "required": false, 
               "type": "string", 
               "title": "Telephone Number"
          }, 
          "mobileNumber": {
               "required": false, 
               "type": "string", 
               "title": "User's Mobile Number"
          }, 
          "csonline_user": {
               "type": "string", 
               "title": "CS Online User"
          }, 
          "usage_location": {
               "readonly": true, 
               "required": false, 
               "type": "string", 
               "description": "Location used for Microsoft Licensing", 
               "title": "Usage Location"
          }, 
          "custom_string_1": {
               "type": "string", 
               "title": "custom_string_1"
          }, 
          "custom_boolean_9": {
               "type": "boolean", 
               "title": "custom_boolean_9"
          }, 
          "custom_string_3": {
               "type": "string", 
               "title": "custom_string_3"
          }, 
          "custom_string_2": {
               "type": "string", 
               "title": "custom_string_2"
          }, 
          "custom_string_5": {
               "type": "string", 
               "title": "custom_string_5"
          }, 
          "custom_string_4": {
               "type": "string", 
               "title": "custom_string_4"
          }, 
          "custom_string_7": {
               "type": "string", 
               "title": "custom_string_7"
          }, 
          "qagroup_name": {
               "description": "Can be used to configure settings on the Teams user based on data.LyncQuickAddGroups-Teams. Otherwise Values will use the Microsoft Site Defaults", 
               "format": "uri", 
               "required": true, 
               "choices": [], 
               "target_attr": "group_name", 
               "target_model_type": "data/QuickAddGroups", 
               "title": "Quick Add Group", 
               "type": "string", 
               "target": "/api/data/QuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "custom_boolean_5": {
               "type": "boolean", 
               "title": "custom_boolean_5"
          }, 
          "custom_boolean_4": {
               "type": "boolean", 
               "title": "custom_boolean_4"
          }, 
          "custom_boolean_7": {
               "type": "boolean", 
               "title": "custom_boolean_7"
          }, 
          "custom_boolean_6": {
               "type": "boolean", 
               "title": "custom_boolean_6"
          }, 
          "custom_boolean_1": {
               "type": "boolean", 
               "title": "custom_boolean_1"
          }, 
          "custom_boolean_3": {
               "type": "boolean", 
               "title": "custom_boolean_3"
          }, 
          "custom_boolean_2": {
               "type": "boolean", 
               "title": "custom_boolean_2"
          }, 
          "class_of_service": {
               "required": false, 
               "type": "string", 
               "description": "Select the Class of Service to apply to the Teams Client. This controls what call types are dialable within the country dialplan (International, Premium, Service,....). The Class of Service behaviour maps directly equivalent CoS in CUCM.", 
               "title": "Class of Service"
          }, 
          "custom_boolean_8": {
               "type": "boolean", 
               "title": "custom_boolean_8"
          }
     }, 
     "schema_version": "1.2"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/QuickSubscriberForMsTeamsMultiVendor/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/QuickSubscriberForMsTeamsMultiVendor as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/QuickSubscriberForMsTeamsMultiVendor/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for view/QuickSubscriberForMsTeamsMultiVendor	POST	/api/view/QuickSubscriberForMsTeamsMultiVendor/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/QuickSubscriberForMsTeamsMultiVendor	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/view/QuickSubscriberForMsTeamsMultiVendor/	hierarchy=[hierarchy] format=json schema=true	The view/QuickSubscriberForMsTeamsMultiVendor schema and all instances as JSON.

(The list will return 0 to 3 view/QuickSubscriberForMsTeamsMultiVendor instances)

GET http://[host]/api/view/QuickSubscriberForMsTeamsMultiVendor/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "add", 
          "help", 
          "configuration_template", 
          "field_display_policy", 
          "export_bulkload_template", 
          "transform"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/view/QuickSubscriberForMsTeamsMultiVendor/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "1.2", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/view/QuickSubscriberForMsTeamsMultiVendor/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/view/QuickSubscriberForMsTeamsMultiVendor/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/QuickSubscriberForMsTeamsMultiVendor/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/QuickSubscriberForMsTeamsMultiVendor/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/QuickSubscriberForMsTeamsMultiVendor", 
          "model_specific_actions": [
               "add"
          ], 
          "summary_attrs": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for view/QuickSubscriberForMsTeamsMultiVendor.	GET	/api/view/QuickSubscriberForMsTeamsMultiVendor/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/QuickSubscriberForMsTeamsMultiVendor as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Help	GET	/api/view/QuickSubscriberForMsTeamsMultiVendor/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/QuickSubscriberForMsTeamsMultiVendor.

API Reference for view/QuickSubscriberForMsTeamsMultiVendor

GET http://[host-proxy]/api/view/QuickSubscriberForMsTeamsMultiVendor/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Export Bulk Load Template

List

GET http://[host]/api/view/QuickSubscriberForMsTeamsMultiVendor/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Help