From VoIP.ms Wiki

[checked revision]

[quality revision]

Revision as of 14:48, 21 May 2024 (view source) RP (Talk | contribs) (→What is VoIP.ms Teams Connector?) ← Older edit		Latest revision as of 18:26, 7 June 2024 (view source) RP (Talk | contribs)
(13 intermediate revisions not shown)
Line 1:		Line 1:
-	= What is VoIP.ms Teams Connector?  =	+	= What is Call Valet with VoIP.ms Teams Connector?  =
-	: The VoIP.ms Teams connector lets you link your VoIP.ms account to Microsoft Teams, so you can make and receive calls via your Microsoft Teams application, whether it’s on mobile, tablet or desktop, while still taking advantage of VoIP.ms hosted features. This connector is powered by TeamMate Technology, a third-party solution enabling seamless integration with Teams. Practically speaking, your Microsoft Teams becomes your softphone, giving you the option of using the built-in dial pad to make or receive calls. You may also link your VoIP.ms account to Microsoft Teams to [[VoIP.ms_Teams_Connector#SMS_Connector_To_be_released_by_Q2_2024 | send and receive text messages directly within Teams]]. '''Please note that you will need a Microsoft E1 license at the very minimum to be able to leverage this connector.''' For more information on Microsoft licenses, [[VoIP.ms_Teams_Connector_Licensing | please check here]].	+	: Call Valet is an extension application on your Microsoft teams that allows you to send and receive phone calls. If you do not have a VoIP.ms Teams Connector configured yet, [[VoIP.ms_Teams_Connector | visit this article to get started]].
-		+
-	= VoIP.ms Technical Requirements =	+
-	You require a PBX Connector in order to have the CallApp / Valet. For more information, [[VoIP.ms_Teams_Connector | visit this article to get started]].	+
-	= Valet (Call App) provisioning =
		+	= Step-by-step Configuration =
		+
		+	: Please follow the instructions below to get started. Note that this process requires the involvement of the '''Microsoft Global Administrator'''. Some tasks can be delegated from the global admin to the '''Microsoft Teams Service Admin''' or '''Skype Admin''', but due to Microsoft's security policies there is '''no way to complete setup without the Global Administrator initial involvement'''
		+
		+
	: <h3> 1 - Verify licenses </h3>		: <h3> 1 - Verify licenses </h3>
-	:: '''1.''' Make sure a Phone System Resource Account license is available. Phone System Resource Account licenses are only available if you have a subscription for a Phone System license.	+	:: '''1.1''' Make sure a Microsoft Teams Phone Resource Account is available. Phone System Resource Account licenses are only available if you have a subscription for a Phone System license. On how to acquire one, consult [https://learn.microsoft.com/en-us/microsoftteams/teams-add-on-licensing/virtual-user#how-to-obtain-microsoft-teams-phone-resource-account-licenses this article].
	::: [[File:001_Valet_License.png|border|600px]]		::: [[File:001_Valet_License.png|border|600px]]
-		+
-	:: '''2.''' Make sure that you have an available PBX extension to assign to the Application instance.	+
-		+
	: <h3> 2 - Grant [https://connecttoteams.elevio.help/articles/17 permissions]. </h3>		: <h3> 2 - Grant [https://connecttoteams.elevio.help/articles/17 permissions]. </h3>
-	:: '''1.''' The global administrator must click the link provided in the email they receive.	+	:: '''2.1''' Once our team processed your request, the global administrator will receive an email and will need to click the “Complete” button at the bottom of the e-mail.
-		+
-	:: '''1.1''' For this, at the bottom of the email you will find a button with the text "Complete".	+
	::: [[File:003 GlobalAdmin Email1.png.png|border|400px]]		::: [[File:003 GlobalAdmin Email1.png.png|border|400px]]
-	:: '''2.''' ConnecttoTeams performs certain limited tasks with the Microsoft Global Administrators' consent. It allows for automated provisioning via PowerShell of Direct Routing, User Calling activation and Teams Application setup in Microsoft.	+	:: '''2.2''' The initial request when the Microsoft Enterprise Global Administrator is asked for permission looks like this:
-		+
-	:: '''2.1''' The initial request when the Microsoft Enterprise Global Administrator is asked for permission looks like this:	+
	::: [[File:002_Valet_Permission.png|border|200px]]		::: [[File:002_Valet_Permission.png|border|200px]]
Line 35:		Line 30:
	: <h3> 3 - User Groups Sync. </h3>		: <h3> 3 - User Groups Sync. </h3>
-	:: '''1.''' On the initial login to the Enterprise Portal, the enterprise Global Administrator will be redirected to the User Group Sync page and must select whether Users will be synchronized by specifying one or more Groups to serve as filters.	+	:: '''3.1''' Once the permission has been granted, the administrator of the [https://service.connecttoteams.com/ ConnectToTeams Portal] will need to login he will be redirected to the User Group Sync page. You '''must''' select whether Users will be synchronized by specifying one or more Groups.
	:::* If no Group(s) are selected, then all Users of the enterprise will be synchronized.		:::* If no Group(s) are selected, then all Users of the enterprise will be synchronized.
	:::* If any Group(s) are selected, then only Users that belong to the Group(s) will be synchronized.		:::* If any Group(s) are selected, then only Users that belong to the Group(s) will be synchronized.
-	::::'''Note''' The Portal WILL NOT synchronize or store Users that are not part of the selected Group(s).
-	:: '''1.1''' The image below shows a case where two Microsoft Groups (Accounting and Billing) have been selected to be synchronized.	+
		+	<div style="margin-left:50px;
		+	padding:5px;
		+	border-left: 6px solid rgb(208, 56, 45, 0.8);
		+	box-shadow: 8px 6px 9px -2px #f2f2f2;
		+	background-color: rgba(208, 56, 45, 0.08);
		+	width:70vw;">
		+
		+	🚨 '''Important'''
		+	: The Portal WILL NOT synchronize or store Users that are not part of the selected Group(s).
		+	</div>
		+
		+
		+	:: The image below shows a case where two Microsoft Groups (Accounting and Billing) have been selected to be synchronized.
	::: [[File:003_Valet_Sync_Groups.png|border|600px]]		::: [[File:003_Valet_Sync_Groups.png|border|600px]]
Line 48:		Line 55:
	: <h3> 4 - Save The App Template. </h3>		: <h3> 4 - Save The App Template. </h3>
-	:: '''1.''' You need to create a template for the Teams Application that will house the Valet App interface. This template will set your default settings for any applications that are deployed to your enterprises.	+	:: You need to create a template for the Teams Application that will house the Valet App interface. This template will set your default settings for any applications that are deployed to your enterprises.
-	:: '''2.''' Save it first via the "App Template".	+	:: '''4.1''' Head to ''App Template''.
		+
		+	:: '''4.2''' Fill the following information:
		+	::* '''Dev Name''': VoIP.ms
		+	::* '''Short Description''': Put a short description for your team to refer to when they will go on '''About''' screen of the application.
		+	::* '''Full Description''': Set a full description for your team to refer to when they will go on '''About''' screen of the application.
		+
		+	:: '''4.3''' Save the template by pressing '''Save Valet App Template".
	::: [[File:004_Valet_App_Template.png|border|600px]]		::: [[File:004_Valet_App_Template.png|border|600px]]
Line 57:		Line 71:
	: <h3> 5 - Set Up Direct Routing. </h3>		: <h3> 5 - Set Up Direct Routing. </h3>
-	:: '''1.''' Make sure you have at least 1 available '''AND''' unassigned User license with the Phone System, or comparable, add-on that allows you to use Direct Routing.	+	:: '''5.1''' Make sure you have at least 1 available '''AND''' unassigned licensed user that also has the Phone System or Enterprise Premium License.
	::: [[File:004_Valet_Direct_Routing_1.png|border|300px]]		::: [[File:004_Valet_Direct_Routing_1.png|border|300px]]
-	:: '''2.''' Select the desired Gateway, paste the invitation code from the email then click the Complete Direct Routing.	+	:: '''5.2''' Select the desired Gateway, paste the invitation code from the email you previously received and then click '''Complete Direct Routing'''.
-		+
-	:: '''3.''' The "Verify Tenant" will pop up, this will verify the connection to the DNS Provider and will validate licenses. Click "Complete Direct Routing" as soon as it is done with the verification.	+
	::: [[File:004_Valet_Direct_Routing_2.png|border|300px]]		::: [[File:004_Valet_Direct_Routing_2.png|border|300px]]
		+
		+	:: '''5.3''' A popup stating "Verify Tenant" will appear. This will verify the connection to the DNS Provider and it will also validate licenses. Click "Complete Direct Routing" once more after the verification has been complete.
-	:: '''4.''' Direct Routing provisioning will take a few minutes, refresh the dashboard page after 2-3 minutes to check progress.	+	:: '''5.4''' The provisioning of the Direct Routing takes a few minutes. You can refresh the dashboard page after 2-3 minutes to check the progress.
	::: [[File:004_Valet_Direct_Routing_3.png|border|300px]]		::: [[File:004_Valet_Direct_Routing_3.png|border|300px]]
-	: <h3> 6 - Configure PBX settings. </h3>	+	: <h3> 6 - Configure your PBX Settings </h3>
-	:: '''1.''' Navigate to “PBX Settings” section to add a new PBX connection.	+	:: '''6.1''' Still in the [https://enterprise.connecttoteams.com/ ConnectToTeams Portal], navigate to the '''PBX''' section on the left menu and add a new PBX connection with the "Add PBX" button.
	::: [[File:006_Add_PBX_Connector.png|border|600px]]		::: [[File:006_Add_PBX_Connector.png|border|600px]]
-	:: '''2.''' Input the VoIP.ms parameters required for the PBX connector.	+	:: '''6.2''' Input the VoIP.ms parameters required for the PBX connector.
-		+
-	:::'''Note''' This task can be delegated to someone other than the Microsoft Global Administrator.	+	:: Necessary PBX information includes:
-		+
-	:: '''2.1''' Necessary PBX information includes:	+
	:::* '''PBX SIP Domain (required)''': VoIP.ms POP Server Hostname - [https://wiki.voip.ms/article/Choosing_Server See full list of servers]		:::* '''PBX SIP Domain (required)''': VoIP.ms POP Server Hostname - [https://wiki.voip.ms/article/Choosing_Server See full list of servers]
	:::* '''PBX SIP Domain Proxy''': VoIP.ms POP Server Hostname - [https://wiki.voip.ms/article/Choosing_Server See full list of servers]		:::* '''PBX SIP Domain Proxy''': VoIP.ms POP Server Hostname - [https://wiki.voip.ms/article/Choosing_Server See full list of servers]
	:::* '''Voicemail Feature Code''': *97		:::* '''Voicemail Feature Code''': *97
	:::* '''PBX SIP Domain Procy Port''': 5060		:::* '''PBX SIP Domain Procy Port''': 5060
-	:::* '''Codecs''': G722 Only (Be sure the sub-account is set with this codec)	+	:::* '''Codecs''': G711U Only (Be sure the sub-account is set with this codec)
	:::* '''Reg Expires''': 600		:::* '''Reg Expires''': 600
	:::* '''Caller ID on Forwarding''': '''User's Caller ID'''		:::* '''Caller ID on Forwarding''': '''User's Caller ID'''
Line 100:		Line 112:
	: <h3> 7 - Create/Configure Application Instance. </h3>		: <h3> 7 - Create/Configure Application Instance. </h3>
-	:: '''1.''' The Global Administrator commences the process by clicking the Setup button in the Enterprise Admin Action Items. This step enables the Valet Application Service and the Application Instance for Enterprise.  This process automatically creates the "valetservice" user and assigns the Phone System Resource Account made available as part of the prerequisite.	+	:: '''7.1''' You will now need to create a pilot valet, which will only be used for synchronization purposes. The Global Administrator can start the process by clicking '''Dashboard''' on the left menu and then clicking the '''Setup''' button next to '''Teams Valet App'''. This step enables the Valet Application Service and the Application Instance.
	::: [[File:005_Valet_Configure_App_1.png|border|600px]]		::: [[File:005_Valet_Configure_App_1.png|border|600px]]
-	:: '''2.''' Once complete you will see the ‘valetservice’ in the users page.	+	:: '''7.2''' Next, configure the Valet Service Account by clicking the '''Configure''' button. This step assigns a Phone Number to the user created as part of the Setup.
-		+
-	::: [[File:005_Valet_Configure_App_2.png|border|600px]]	+
-		+
-		+
-	:: '''3.''' Still under the Enterprise Admin Action Items, configure the Valet Service Account by clicking the Configure button. This will take you to the Configure Valet Service Account page where you can select the Application Instance user. This step assigns a Phone Number to the "valetservice" user created as part of the ‘Setup’.	+
	::: [[File:005_Valet_Configure_App_3.png|border|600px]]		::: [[File:005_Valet_Configure_App_3.png|border|600px]]
-	:: '''4.''' Add the Application Instance user as you would add a regular Teams PBX user then click Save.	+	:: '''7.3''' Fill in the following information:
-		+	::* '''PBX Location''': The location previously created when configure your PBX Connector
		+	::* '''Available Voice Routes''': The Server your PBX Connector has been configured to.
		+	::* '''Teams User''': The pilot user that will be used for this pilot account for sinchronization purposes.
		+	::* '''Phone Number''': The phone number that this user will be passing for his outgoing calls.
		+	::* '''SIP User''': Your sub account userID. E.g: 111111_subaccount.
		+	::* '''SIP Authentication ID''': Your sub account userID. E.g: 111111_subaccount.
		+	::* '''SIP Password''': Your sub account password you entered while creating the sub account.
		+	::* '''Confirm SIP Password''': Confirm your sub account password.
		+
		+	<div style="margin-left:50px;
		+	padding:5px;
		+	border-left: 6px solid rgb(208, 56, 45, 0.8);
		+	box-shadow: 8px 6px 9px -2px #f2f2f2;
		+	background-color: rgba(208, 56, 45, 0.08);
		+	width:70vw;">
		+
		+	🚨 '''Important'''
		+	: Make sure that the sub account configured on this step is '''not''' a sub account that will be used by any users. This sub account will only be used for sinchronization purposes.
		+	</div>
		+
		+
	::: [[File:005_Valet_Configure_App_4.png|border|600px]]		::: [[File:005_Valet_Configure_App_4.png|border|600px]]
-	:: '''5.''' Grant the Consent for the Application to enable the Valet App Instance user.	+	:: '''7.4''' Press '''Save Valet Service Account''' and you will then need to grant the Consent for the Application to appear for the user.
	::: [[File:005_Valet_Configure_App_5.png|border|600px]]		::: [[File:005_Valet_Configure_App_5.png|border|600px]]
-	:: '''6.''' A headset icon will represent the App Instance user in the dashboard	+	:: '''7.5''' Once you are done assigning the valet application to all your users, you can return to the '''Dashboard''' main menu by clicking it on the left, and deploy the Valet App by clicking the '''Sync Valet App''' button, then clicking '''Provision Application'''.
-		+
-	::: [[File:005_Valet_Configure_App_6.png|border|600px]]	+
		+	::: [[File:005_Valet_Configure_App_7.png|border|600px]]
-	:: '''7.''' Deploy the Valet App by clicking the Sync Valet App button, then click Provision Application.	+	:: '''7.6''' Once complete, you can consult all the users with the application enabled by going into '''Users''' on the left menu. You will see the valet service enabled which is a green headset icon.
-	::: [[File:005_Valet_Configure_App_7.png|border|600px]]	+	::: [[File:005_Valet_Configure_App_2.png|border|600px]]
-	: <h3> 8 - Create/Configure Application Instance. </h3>	+	: <h3> 8 - Create/Configure the Application Instance. </h3>
-	:: '''1.''' Click the Configure Valet App Users from the Users page.	+	:: '''8.1''' Head on '''USers''' on the left menu, and then click '''Configure Valet App Users'''.
	::: [[File:005_Valet_Configure_App_9.png|border|600px]]		::: [[File:005_Valet_Configure_App_9.png|border|600px]]
-	:: '''2.''' Add a Valet user as you would add a regular Teams PBX user then click Save.	+	:: '''8.2''' Fill in the following information:
		+	::* '''PBX Location''': The location previously created when configure your PBX Connector
		+	::* '''Available Voice Routes''': The Server your PBX Connector has been configured to.
		+	::* '''Teams User''': The user you wish to configure.
		+	::* '''Phone Number''': The phone number that this user will be passing for his outgoing calls.
		+	::* '''SIP User''': Your sub account userID. E.g: 111111_subaccount.
		+	::* '''SIP Authentication ID''': Your sub account userID. E.g: 111111_subaccount.
		+	::* '''SIP Password''': Your sub account password you entered while creating the sub account.
		+	::* '''Confirm SIP Password''': Confirm your sub account password.
	::: [[File:005_Valet_Configure_App_10.png|border|600px]]		::: [[File:005_Valet_Configure_App_10.png|border|600px]]
-	:: '''2.1''' A fully configured Valet App User will show a telephone icon for Teams Registration.	+	:: '''8.3''' Once done, press '''Save Valet User'''. A fully configured Valet App User will show a telephone icon for Teams Registration.
	::: [[File:005_Valet_Configure_App_11.png|border|600px]]		::: [[File:005_Valet_Configure_App_11.png|border|600px]]
Line 154:		Line 188:
	: <h3> 9 - End user configuration. </h3>		: <h3> 9 - End user configuration. </h3>
-	:: '''1.''' Each configured Valet user will need to add the Valet app.	+	:: '''9.1''' Each configured user will need to add the Valet application. In teams, press '''...''' search for voipms select '''VoIPms Call App'''
-	::: [[File:005_Valet_Configure_App_12.png|border|300px]]	+	::: [[File:VoipmsCallApp1.png|border|300px]]
-	:: '''2.''' Add the app, and then pin it to the sidebar by right-clicking and selecting "Pin."	+	:: '''9.2''' Pin it to the sidebar by right-clicking the application on the left bar and selecting "Pin."
-	::: [[File:005_Valet_Configure_App_13.png|border|300px]]	+	::: [[File:VoipmsCallApp2.png|border|300px]]
-	:: '''3.''' And that's it! Use the dialpad in the App to make calls.	+	:: '''9.3''' And that's it! You can now make use of the dialpad in the App to make and receive calls!
-	::: [[File:005_Valet_Configure_App_14.png|border|300px]]	+	::: [[File:VoipmsCallApp3.png|border|300px]]
-		+
	= Related Articles=		= Related Articles=

---

Latest revision as of 18:26, 7 June 2024

Contents 1 What is Call Valet with VoIP.ms Teams Connector? 2 Step-by-step Configuration 2.1 1 - Verify licenses 2.2 2 - Grant permissions. 2.3 3 - User Groups Sync. 2.4 4 - Save The App Template. 2.5 5 - Set Up Direct Routing. 2.6 6 - Configure your PBX Settings 2.7 7 - Create/Configure Application Instance. 2.8 8 - Create/Configure the Application Instance. 2.9 9 - End user configuration. 3 Related Articles 4 Useful Resources

What is Call Valet with VoIP.ms Teams Connector?

Call Valet is an extension application on your Microsoft teams that allows you to send and receive phone calls. If you do not have a VoIP.ms Teams Connector configured yet, visit this article to get started.

Step-by-step Configuration

Please follow the instructions below to get started. Note that this process requires the involvement of the Microsoft Global Administrator. Some tasks can be delegated from the global admin to the Microsoft Teams Service Admin or Skype Admin, but due to Microsoft's security policies there is no way to complete setup without the Global Administrator initial involvement

1 - Verify licenses

1.1 Make sure a Microsoft Teams Phone Resource Account is available. Phone System Resource Account licenses are only available if you have a subscription for a Phone System license. On how to acquire one, consult this article.

2 - Grant permissions.

2.1 Once our team processed your request, the global administrator will receive an email and will need to click the “Complete” button at the bottom of the e-mail.

2.2 The initial request when the Microsoft Enterprise Global Administrator is asked for permission looks like this:

3 - User Groups Sync.

3.1 Once the permission has been granted, the administrator of the ConnectToTeams Portal will need to login he will be redirected to the User Group Sync page. You must select whether Users will be synchronized by specifying one or more Groups.

• If no Group(s) are selected, then all Users of the enterprise will be synchronized.
• If any Group(s) are selected, then only Users that belong to the Group(s) will be synchronized.

The image below shows a case where two Microsoft Groups (Accounting and Billing) have been selected to be synchronized.

4 - Save The App Template.

You need to create a template for the Teams Application that will house the Valet App interface. This template will set your default settings for any applications that are deployed to your enterprises.

4.1 Head to App Template.

4.2 Fill the following information:

• Dev Name: VoIP.ms
• Short Description: Put a short description for your team to refer to when they will go on About screen of the application.
• Full Description: Set a full description for your team to refer to when they will go on About screen of the application.

4.3 Save the template by pressing Save Valet App Template".

5 - Set Up Direct Routing.

5.1 Make sure you have at least 1 available AND unassigned licensed user that also has the Phone System or Enterprise Premium License.

5.2 Select the desired Gateway, paste the invitation code from the email you previously received and then click Complete Direct Routing.

5.3 A popup stating "Verify Tenant" will appear. This will verify the connection to the DNS Provider and it will also validate licenses. Click "Complete Direct Routing" once more after the verification has been complete.

5.4 The provisioning of the Direct Routing takes a few minutes. You can refresh the dashboard page after 2-3 minutes to check the progress.

6 - Configure your PBX Settings

6.1 Still in the ConnectToTeams Portal, navigate to the PBX section on the left menu and add a new PBX connection with the "Add PBX" button.

6.2 Input the VoIP.ms parameters required for the PBX connector.

Necessary PBX information includes:

• PBX SIP Domain (required): VoIP.ms POP Server Hostname - See full list of servers
• PBX SIP Domain Proxy: VoIP.ms POP Server Hostname - See full list of servers
• Voicemail Feature Code: *97
• PBX SIP Domain Procy Port: 5060
• Codecs: G711U Only (Be sure the sub-account is set with this codec)
• Reg Expires: 600
• Caller ID on Forwarding: User's Caller ID

Important: The SIP Domain and Proxy must be the same server used Point of Presence for your DID number(s)

• Caller Name Policy: Other
• Custom Caller Name: See the requirements below.

7 - Create/Configure Application Instance.

7.1 You will now need to create a pilot valet, which will only be used for synchronization purposes. The Global Administrator can start the process by clicking Dashboard on the left menu and then clicking the Setup button next to Teams Valet App. This step enables the Valet Application Service and the Application Instance.

7.2 Next, configure the Valet Service Account by clicking the Configure button. This step assigns a Phone Number to the user created as part of the Setup.

7.3 Fill in the following information:

• PBX Location: The location previously created when configure your PBX Connector
• Available Voice Routes: The Server your PBX Connector has been configured to.
• Teams User: The pilot user that will be used for this pilot account for sinchronization purposes.
• Phone Number: The phone number that this user will be passing for his outgoing calls.
• SIP User: Your sub account userID. E.g: 111111_subaccount.
• SIP Authentication ID: Your sub account userID. E.g: 111111_subaccount.
• SIP Password: Your sub account password you entered while creating the sub account.
• Confirm SIP Password: Confirm your sub account password.

7.4 Press Save Valet Service Account and you will then need to grant the Consent for the Application to appear for the user.

7.5 Once you are done assigning the valet application to all your users, you can return to the Dashboard main menu by clicking it on the left, and deploy the Valet App by clicking the Sync Valet App button, then clicking Provision Application.

7.6 Once complete, you can consult all the users with the application enabled by going into Users on the left menu. You will see the valet service enabled which is a green headset icon.

8 - Create/Configure the Application Instance.

8.1 Head on USers on the left menu, and then click Configure Valet App Users.

8.2 Fill in the following information:

• PBX Location: The location previously created when configure your PBX Connector
• Available Voice Routes: The Server your PBX Connector has been configured to.
• Teams User: The user you wish to configure.
• Phone Number: The phone number that this user will be passing for his outgoing calls.
• SIP User: Your sub account userID. E.g: 111111_subaccount.
• SIP Authentication ID: Your sub account userID. E.g: 111111_subaccount.
• SIP Password: Your sub account password you entered while creating the sub account.
• Confirm SIP Password: Confirm your sub account password.

8.3 Once done, press Save Valet User. A fully configured Valet App User will show a telephone icon for Teams Registration.

9 - End user configuration.

9.1 Each configured user will need to add the Valet application. In teams, press ... search for voipms select VoIPms Call App

9.2 Pin it to the sidebar by right-clicking the application on the left bar and selecting "Pin."

9.3 And that's it! You can now make use of the dialpad in the App to make and receive calls!

Related Articles

• VoIP.ms Teams Connector
• License requirement to use VoIP.ms Teams Connector

Useful Resources

• TeamMate FAQ
• Youtube - TeamMate PBX Connector - How it Works
• Connect to Teams knowledge base