[Index]

Model: view/QuickSubscriberForMsTeamsMultiVendor

Quick Add Subscriber

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure adds a single Microsoft user via quick add subscriber (QAS), and moves the user to the correct site, with all configuration and licensing applied.

Note

The Quick Add Subscriber (QAS) feature simplifies onboarding with the use of Quick Add Groups (QAGs). Quick Add Groups are service and policy assignment templates that allow you to pre-configure how calling rights, policies, and services are assigned to users based on their user role. When adding a user via QAS, you select the relevant QAG, and the automated workflows in VOSS Automate handles the required cloud sync and licensing. The workflow also removes the need for an administrator to check the licensing, or to flag the required policies and settings individually, and then to wait for the cloud to sync in.

Prerequisites:

Perform these steps:

  1. Log in to the Admin Portal as a provider admin, at the customer level.

  2. Go to (default menu) MS Subscriber Management > Quick Add Subscriber.

  3. From the organization picker, choose the relevant site.

  4. On the Quick Add Subscriber page:

  5. Go to MS Subscriber Management > Subscriber Staging to view the user in the staging queue.

    VOSS Automate places the user in staging (with all configuration applied), while waiting for the cloud to sync in. Once the licensed user appears in the Microsoft Teams portal, a second, targeted sync is triggered, which searches only for staged users (not all users from the tenant).

    Once the sync completes, the user becomes a fully provisioned subscriber, and the number is flagged as used. The subscriber receives a welcome email (if you've chosen this option, and you have a SMTP server configured).

  6. Verify that the subscriber is configured and licensed:

Related Topics

Microsoft Overview in the Core Feature Guide

Microsoft User Move Configuration in the Core Feature Guide

MV QAS View

Model Details: view/QuickSubscriberForMsTeamsMultiVendor

Title Description Details
Username *
  • Field Name: username
  • Type: String
Include users at higher hierarchy Includes users above site level when searching
  • Field Name: lookUpForUser
  • Type: Boolean
Fail Transaction if user not found used with API to prevent creation of local users where LDAP is in use
  • Field Name: failIfNotFound
  • Type: Boolean
Entitlement Profile
  • Field Name: entitlement_profile
  • Type: String
First Name
  • Field Name: firstname
  • Type: String
Last Name
  • Field Name: lastname
  • Type: String
Email Address
  • Field Name: email
  • Type: String
  • Pattern: ^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$
  • Format: email
Password The corresponding CUCM, CUC and WebEx user password will be set with this password
  • Field Name: password
  • Type: String
  • Is Password: True
PIN The corresponding CUCM and CUC user PIN will be set with this PIN
  • Field Name: pin
  • Type: String
  • Is Password: True
Manager
  • Field Name: manager
  • Type: String
Department
  • Field Name: department
  • Type: String
Telephone Number
  • Field Name: telephoneNumber
  • Type: String
Title
  • Field Name: title
  • Type: String
Home Number
  • Field Name: homeNumber
  • Type: String
User's Mobile Number
  • Field Name: mobileNumber
  • Type: String
Directory URI
  • Field Name: directoryUri
  • Type: String
Quick Add Group *
  • Field Name: qagroup_name
  • Type: String
  • Target: data/QuickAddGroups
  • Target attr: group_name
  • Format: uri
Device Pools
  • Field Name: device_pool
  • Type: String
Class of Service Select to apply CSS's to lines and devices as defined in the selected Class of Service definition.
  • Field Name: class_of_service
  • Type: String
User Status & Existing Services
  • Field Name: existing
  • Type: Object
User Type
  • Field Name: existing.UserType
  • Type: String
CUCM User LDAP Directory Name
  • Field Name: existing.cucm_user_ldapDirectoryName
  • Type: String
CUCM User Identity / AD UserPrincipalName
  • Field Name: existing.cucm_user_identity
  • Type: String
Phones
  • Field Name: existing.phones
  • Type: String
Extension Mobility Profiles
  • Field Name: existing.ext_mobilities
  • Type: String
Voicemail Extension
  • Field Name: existing.voicemail
  • Type: String
WebEx
  • Field Name: existing.webex
  • Type: String
Single Number Reach
  • Field Name: existing.snr
  • Type: String
Webex Teams
  • Field Name: existing.spark
  • Type: String
Contact Center
  • Field Name: existing.contact_center
  • Type: String
Teams Licenses
  • Field Name: teams_licenses.[n]
  • Type: Array
Name
  • Field Name: existing.teams_licenses.[n].Name
  • Type: String
AccountSkuId
  • Field Name: existing.teams_licenses.[n].AccountSkuId
  • Type: String
Licence for MS Teams Telephony Available
  • Field Name: existing.teamsTelephonyAllowed
  • Type: Boolean
MS Teams Telephony License
  • Field Name: existing.teamsTelephonyLicense
  • Type: String
Teams Line URI
  • Field Name: existing.teams_line_uri
  • Type: String
MS Teams UserPrincipalName
  • Field Name: existing.teams_msol_upn
  • Type: String
User status
  • Field Name: user_status
  • Type: String
Lines
  • Field Name: lines.[n]
  • Type: Array
Inventory Filter Default: Default
  • Field Name: lines.[n].line_filter
  • Type: String
  • Default: Default
  • Choices: ["Default", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Directory Number
  • Field Name: lines.[n].directory_number
  • Type: String
Directory Number
  • Field Name: line1DN
  • Type: String
E164 Number
  • Field Name: line1E164
  • Type: String
Voice
  • Field Name: voice
  • Type: Boolean
Phones
  • Field Name: phones.[n]
  • Type: Array
Phone Name Name of phone to provision for e.g. SEPABCDEFABCDEF
  • Field Name: phones.[n].phone_name
  • Type: String
  • Target: device/cucm/Phone
  • Target attr: name
  • Format: uri
Microsoft Teams
  • Field Name: ms_teams
  • Type: Boolean
Service Type *
  • Field Name: MultiVendorServiceType
  • Type: String
Usage Location Location used for Microsoft Licensing
  • Field Name: usage_location
  • Type: String
Extension Mobility
  • Field Name: mobility
  • Type: Boolean
Voicemail
  • Field Name: voicemail
  • Type: Boolean
WebEx
  • Field Name: webex
  • Type: Boolean
Single Number Reach
  • Field Name: snr
  • Type: Boolean
Webex Teams
  • Field Name: spark
  • Type: Boolean
Webex Teams Template
  • Field Name: spark_template
  • Type: String
Contact Center Agent
  • Field Name: contact_center
  • Type: Boolean
Agent Profile
  • Field Name: contact_center_profile
  • Type: String
Agent Extension
  • Field Name: contact_center_extension
  • Type: String
Agent Device Type Default: Phone
  • Field Name: contact_center_device_type
  • Type: String
  • Default: Phone
  • Choices: ["Phone", "Extension Mobility"]
Agent Device
  • Field Name: contact_center_device
  • Type: String
EMCC
  • Field Name: emcc
  • Type: Boolean
SNR Mobile Number
  • Field Name: mobile_number
  • Type: String
Jabber / Dual-Mode Device When adding a Jabber device also specify a line to be associated. The first line specified will be used for any Jabber device added here.
  • Field Name: jabber
  • Type: Boolean
Jabber Agent
  • Field Name: jabber_agent
  • Type: String
  • Choices: ["Android", "CSF", "iPad", "iPhone"]
Jabber and Dual-Mode Devices
  • Field Name: jabber_devices.[n]
  • Type: Array
Jabber / Dual-Mode Agent
  • Field Name: jabber_devices.[n].jabber_agent
  • Type: String
  • Choices: ["Android", "CSF", "iPad", "iPhone", "Carrier Integrated Mobile", "CTI Remote Device"]
Device Name
  • Field Name: jabber_devices.[n].device_name
  • Type: String
Mobile Identity
  • Field Name: jabber_devices.[n].mobile_identity
  • Type: Boolean
Destination
  • Field Name: jabber_devices.[n].mobile_identity_destination
  • Type: String
Enable Self Provisioning
  • Field Name: self_service_id
  • Type: Boolean
Self Provisioning User Profile
  • Field Name: self_provisioning_profile
  • Type: String
LDAP User
  • Field Name: ldap_user
  • Type: String
Normalized User
  • Field Name: normalized_user
  • Type: String
CUCM User
  • Field Name: cucm_user
  • Type: String
MSOL User
  • Field Name: msol_user
  • Type: String
CS Online User
  • Field Name: csonline_user
  • Type: String
CUCM User LDAP Directory Name
  • Field Name: cucm_user_ldapDirectoryName
  • Type: String
Phone Template
  • Field Name: phone_template
  • Type: String
Phone Type
  • Field Name: phone_type
  • Type: String
Phone Protocol
  • Field Name: phone_protocol
  • Type: String
Phone Button Template
  • Field Name: button_template
  • Type: String
Phone Security Profile
  • Field Name: security_profile
  • Type: String
does_phonetype_support_pac
  • Field Name: does_phonetype_support_pac
  • Type: Boolean
Use Activation Code Onboarding Enabling this checbox will instruct this workflow to add one phone only, using the Activation-Code based registration method. The code will be automatically generated. When selected, the Phone name field also gets hidden because the phone name will be automatically generated when this onboarding method is used.
  • Field Name: enable_activation_code
  • Type: Boolean
Is PhoneType Entitled?
  • Field Name: phonetype_entitled
  • Type: String
External Auto Trigger?
  • Field Name: external_trigger
  • Type: String
custom_string_1
  • Field Name: custom_string_1
  • Type: String
custom_string_2
  • Field Name: custom_string_2
  • Type: String
custom_string_3
  • Field Name: custom_string_3
  • Type: String
custom_string_4
  • Field Name: custom_string_4
  • Type: String
custom_string_5
  • Field Name: custom_string_5
  • Type: String
custom_string_6
  • Field Name: custom_string_6
  • Type: String
custom_string_7
  • Field Name: custom_string_7
  • Type: String
custom_string_8
  • Field Name: custom_string_8
  • Type: String
custom_string_9
  • Field Name: custom_string_9
  • Type: String
custom_string_10
  • Field Name: custom_string_10
  • Type: String
custom_boolean_1
  • Field Name: custom_boolean_1
  • Type: Boolean
custom_boolean_2
  • Field Name: custom_boolean_2
  • Type: Boolean
custom_boolean_3
  • Field Name: custom_boolean_3
  • Type: Boolean
custom_boolean_4
  • Field Name: custom_boolean_4
  • Type: Boolean
custom_boolean_5
  • Field Name: custom_boolean_5
  • Type: Boolean
custom_boolean_6
  • Field Name: custom_boolean_6
  • Type: Boolean
custom_boolean_7
  • Field Name: custom_boolean_7
  • Type: Boolean
custom_boolean_8
  • Field Name: custom_boolean_8
  • Type: Boolean
custom_boolean_9
  • Field Name: custom_boolean_9
  • Type: Boolean
custom_boolean_10
  • Field Name: custom_boolean_10
  • Type: Boolean
Use Entitlement from Service Definition
  • Field Name: forceEp
  • Type: String
Use QAG from Service Definition
  • Field Name: forceQag
  • Type: String
Use MS Teams from Service Definition
  • Field Name: forceMsTeams
  • Type: String
Display Line 1 CoS
  • Field Name: displayLine1CoS
  • Type: Boolean