Yealink Management Cloud Service (YMCS) - VoIP.ms Wiki

Check out our YouTube channel to watch our simple tutorials that will help you set up most of our features.

Yealink Management Cloud Service (YMCS)

From VoIP.ms Wiki

(Difference between revisions)
Jump to: navigation, search
[checked revision][checked revision]
(Guide Links)
 
(18 intermediate revisions not shown)
Line 1: Line 1:
-
[[File:Yealink_logo.png|600px|thumb|right|YMCS]]
+
[[File:Yealink_logo.png|450px|thumb|right]]
<!-- {| class="wikitable"
<!-- {| class="wikitable"
Line 9: Line 9:
|} -->
|} -->
-
Yealink provides the Yealink Management Cloud Service (YMCS) to simplify the process of managing Yealink video and voice communication endpoint devices. YMCS deliver a host of capabilities and integrated functionality to enhance the user experience and to increase user adoption rates while consolidating customers under a cloud management platform.
+
Yealink provides the Yealink Management Cloud Service (YMCS) to simplify the process of managing Yealink video and voice communication endpoint devices.
-
== Connecting YakChat to your VoIP.ms DID ==
+
YMCS delivers a host of capabilities and integrated functionality to enhance the user experience and to increase user adoption rates while consolidating customers under a cloud management platform.
-
=== Pre-requisites ===
+
<br>
 +
== Login into your YMCS ==
-
The YakChat service can connect with your VoIP.ms telephony service in 3 easy steps:
+
To log in, go to [https://dm.yealink.com/ YMCS Login]
-
<ol>
+
There, enter the username and password provided by Yealink to access the platform.
-
  <li>Enable the VoIP.ms API </li>
+
-
  <li>Add SMS and YakChat callback URL to the DID number(s)</li>
+
-
  <li>Send API information to YakChat at [mailto:[email protected] [email protected]]</li>
+
-
</ol>
+
-
 
+
-
The YakChat team then will test the connection for you and confirm when everything is set up.
+
-
 
+
-
=== 1. Enabling the VoIP.ms API ===
+
-
 
+
-
In the Customer Portal head to “Main Menu” and click on the menu “SOAP and REST/JSON API”. 
+
-
 
+
-
On this page, you must create a password for your API (make sure to take note of it) and click on the “Save API Password”.
+
-
 
+
-
Then, click on the button “Enable/Disable API”.  
+
-
Then add the following IP Address by copying and pasting it into the Enable IP Addresses box: 13.89.246.147. If you are already using the API from another IP address you can add this separated by a comma (,). Then click on the button “Save IP addresses”.
+
Once you're logged you'll get access to the dashboard and to all the options available to configure your cloud based platform.
-
[[File:Enable_API_image.png|800px|thumb|left|Enabling the VoIP.ms API]]
+
[[File:Login_YMCS.png|800px|thumb|left]]
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
=== 2. Enable SMS and SMS URL callback for your DID ===
+
== Creating a Site ==
-
In the Customer Portal, head to the option “DID numbers” and click on “Manage DIDs”. On this page, select the number you will use with YakChat and click on the edit button of this (the pencil icon).  
+
One of the first things you need to do when configuring the YMCS is set up the site according to the organizational structure of your company.
-
Once you have done this, head to the bottom of the page and locate the SMS settings. There, check the boxes next to “Message Service”, “SMS URL  Callback” and “URL Callback Retry”.  
+
For this, head to '''Site Management - Add Site'''.
-
On “SMS URL Callback” you also have to enter the following URL: https://services.yakchat.com:2200/message?to={TO}&from={FROM}&message={MESSAGE}&id={ID}&date={TIMESTAMP}&media={MEDIA} 
+
There you only need to assign a name, a parent site (if there's one) and a description for your own use. Click on '''Ok''' when done.
-
Click on Apply changes once everything is set.
+
  Optionally, you can add the IP address of the site.
-
 
+
[[File:YMCS_Site_Management_-_Adding_new_site.png|800px|thumb|left]]
-
[[File:Enable_SMS_and_URL_callback.png|800px|thumb|left|Enabling the VoIP.ms SMS service]]
+
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
=== 3. Send the API details to YakChat ===
+
== Adding Accounts ==
-
Once everything is properly set in the VoIP.ms Customer portal, the YakChat team must activate the service for you.  
+
The next step is adding the SIP accounts that will be used to link your devices with VoIP.ms. Make sure to have created the sub-accounts from your VoIP.ms customer portal at '''Sub Accounts>>Manage Sub Accounts'''.
-
To do so, send the following details to [mailto:info@yakchat.com [email protected]]
+
To set up the account in the YMCS, go to '''Account Management''', click on '''+ Add Account''' and select '''Add SIP Account'''. Then, set this up as follows:
<ol>
<ol>
-
  <li>Portal User ID (email address associated with your VoIP.ms account)</li>
+
  <li>'''Site:''' Select the site where the account belongs</li>
-
  <li>API Password</li>
+
<li>'''Register Name:''' This will be the sub-account username (E.g. 100000_SubAccount)</li>
-
  <li>The DID number you want to use with YakChat</li>
+
  <li>'''Username:''' Same as the Register Name</li>
 +
  <li>'''Password:''' The password of the sub-account you are adding</li>
 +
<li>'''Label:''' Any label you would like to assign to this account</li>
 +
<li>'''Display Name:''' Enter the name that you want to display on the outbound calls made from this account</li>
</ol>
</ol>
-
Make sure you’re sending the VoIP.ms API Password (please do not send your Portal password) in the same email or, if preferred, text the password to (425) 385-0385.  
+
  <font style="color:#FF0000">'''* IMPORTANT'''</font>:
 +
  - We suggest entering your outbound Caller ID Name must be in '''CAPITAL LETTERS'''. This will appears more clearly/visible on some devices.
 +
  - You must '''NOT use any special characters''', they will not be displayed.
 +
  - '''Use Max 15 characters, spaces included'''. Regular Canadian providers will not display more than 15 characters. We suggest shrinking or adapting your caller ID.
 +
  - Spaces are allowed in a caller id name.
-
You could also go to the following link and use the form that is at the end of the page to send the API  details: https://www.yakchat.com/help/voip_ms/
+
[[File:YMCS_Account_Management_-_Add_Account_p1.png|800px|thumb|left]]
-
 
+
-
[[File:Enable_SMS_and_URL_callback.png|800px|thumb|left|Enabling the VoIP.ms SMS service]]
+
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
== Installing YakChat into MS Teams ==
+
== Adding SIP Devices ==
-
<i>'''Important''': The .zip file must be uploaded into Microsoft Teams intact. Do not extract any files contained in the .zip file or the installation process will fail, even if the files are re-compressed into a new .zip file.
+
After the SIP devices are connected to YMCS for enterprise, you need to add the devices to the platform, and then you can do the configuration or other operations.
-
Safari browsers are often set to automatically extract .zip files. This setting must be disabled. You can find instructions on how to do that here.  https://www.youtube.com/watch?v=fZ2han_Er0w  </i>
+
To add a device, in the platform go to '''Device Management''', click on '''Phone Device''' and then on '''Add Device'''. You will need the following information to add it:
-
==== 1. Download YakChat ====
+
<ol>
 +
<li>'''Device name:''' Assign a name to the device</li>
 +
<li>'''Site:''' Select the site the device belongs to</li>
 +
<li>'''Model:''' Search the model of the device you're adding and select it from the list</li>
 +
<li>'''MAC:''' Enter the MAC address. You can see it in the label on the back of the device</li>
 +
<li>'''Machine ID:''' Enter the Machine ID. You can see it in the label on the back of the device</li>
 +
<li>'''Bind Account:''' Add to the device the SIP Accounts that will be used on it</li>
 +
</ol>
-
Firstly, download YakChat App for Microsoft Teams into your default download folder. 
+
[[File:YMCS_Device_Management_-_Phone_Device_-_Add_Device.png|800px|thumb|left]]
-
 
+
-
You can do it from any of the links below: 
+
-
 
+
-
<ul>
+
-
<li>(Direct download link) https://yakchat.com/installation</li>
+
-
<li>https://www.yakchat.com/choose-your-yakchat-application-2/</li>
+
-
</ul>
+
-
 
+
-
As has been noted, you must ensure the .zip file is not unpacked. The whole .zip file must be uploaded into Microsoft Teams.
+
-
 
+
-
[[File:Download_Yakchat.png|800px|thumb|left|Downloading YakChat]]
+
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
==== 2. Install the file into MS teams ====
+
== Device Configuration ==
-
Now open Microsoft Teams. Then click on the “Apps” icon from the toolbar on the left.  
+
To ensure your phones have the proper configuration to work with VoIP.ms you must create templates for the models of the devices that will be part of your sites from the section '''Device Configuration'''>>'''Site Configuration'''. From there, add a template to define the settings your devices will use.
-
[[File:Install_Yakchat_in_MS_Teams_1.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
=== Codecs ===
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
Click on “Manage your apps”. You can find it at the bottom of the Store menu in Microsoft Teams.
+
For better Audio Quality we recommend using the codec G.722. This should be enabled from your customer portal too, in the Sub Account settings.
-
[[File:Install_Yakchat_in_MS_Teams_2.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
[[File:YMCS_Codecs_configuration.png|600px|thumb|left]]
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
Click on “Publish an app” that is located at the top.
+
=== Register ===
-
[[File:Install_Yakchat_in_MS_Teams_3.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
To keep the registration on your devices alive, is recommended to set a Server Expiration time to 120 seconds and enable NAT.
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
Then click on “Upload a customized app” in the pop-up window.
+
[[File:YMCS_Server_Expires.png|600px|thumb|left]]
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_4.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
<div style="width:100%;overflow:hidden;clear:both"></div>
<div style="width:100%;overflow:hidden;clear:both"></div>
-
<i>'''Important''': If the Upload a customized app option is not displayed, then click on Submit and app to your org and after adding the app, contact your Microsoft Teams administrator to approve the app using the Teams Administration Portal. Once approved, you will need to sign out and back into Teams and go to Step 3.</i>
+
==Guide Links==
-
Select “YakChat.zip” file in your browser’s default download folder.
+
'''How to use YMCS''' ''(Detailed guide)'': [https://support.yealink.com/en/portal/knowledge/show?id=60d47355076300004a007061 Yealink Knowledgebase]
-
 
+
-
Then click “Open”.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_5.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
The Microsoft Teams Manifest window will be displayed.
+
-
 
+
-
Now click the “Add” button to add the YakChat app into Microsoft Teams.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_6.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
 
+
-
==== 3. Sign in using Microsoft Credentials ====
+
-
 
+
-
Microsoft Teams will provide a notification window requesting additional permissions.
+
-
 
+
-
Click “Continue”.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_7.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
Microsoft’s authentication window will now be displayed.
+
-
 
+
-
Simply sign-in with your Microsoft Teams email and password. You will also use these to login to YakChat.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_8.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
==== 4. Provide Microsoft Admin Consent (Admin user in MS Teams) ====
+
-
 
+
-
Microsoft’s permission window will be displayed requesting your consent to access the YakChat App.
+
-
 
+
-
Click “Accept” to continue.
+
-
 
+
-
To connect your Microsoft 365 tenant with YakChat requires permission from your Microsoft Teams or Azure administrator.
+
-
 
+
-
If you are an administrator, then you can approve yourself by clicking on the “Accept” button.
+
-
 
+
-
To approve for another user, tick the option: “Consent on behalf of your organization”. Then skip to Step 6.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_9.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
==== 5. Provide Microsoft Admin Consent (Non-Admin user in MS Teams) ====
+
-
 
+
-
If you are not the Microsoft Teams or Azure administrator, you will now be presented with a similar Microsoft permission request window but without the Consent on behalf of your organization option.
+
-
 
+
-
Click on the “Accept” button for a link that your administrator can use to provide admin approval.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_10.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
==== 6. Sign into the YakChat Messaging App ====
+
-
 
+
-
If you are the Microsoft administrator and registered with YakChat the YakChat app will now be displayed.  
+
-
 
+
-
If you are not the Microsoft administrator, you will need to refresh the app and click Sign in.
+
-
 
+
-
You may need to logout and back into Teams if this fails.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_11.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
==== 7. Sign in for Teams Notifications ====
+
-
 
+
-
Just a few more steps to enable YakChat to provide you with new message notifications.
+
-
 
+
-
Click on the Chat tab, then click on the Type your questions here text box and type “Sign in” or use the “What I can do?” menu.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_12.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
Another Microsoft’s authentication window will be displayed.
+
-
 
+
-
Sign-in with your Microsoft Teams Account email and password.
+
-
 
+
-
[[File:Install_Yakchat_in_MS_Teams_13.png|800px|thumb|left|Installing YakChat in MS Teams]]
+
-
<div style="width:100%;overflow:hidden;clear:both"></div>
+
-
 
+
-
==== 8. Sign in Expired ====
+
-
 
+
-
The ‘bot’ sign in adaptive cards expire after about 10 minutes, which will result in the message “The sign in code was was not found or expired message box”.
+
-
 
+
-
If this message is displayed, type “signout” into the Type your questions here text box or select from the "What I can do?" menu and repeat step 7.
+
-
 
+
-
==Guide Links==
+
-
YakChat guide : [https://www.yakchat.com/help/send-your-first-text-from-microsoft-teams/ Send your first text from MS Teams]
+
YMCS Quick Start guide : [https://support.yealink.com/en/portal/docDetail?documentCode=a3c8b1d49190419a Quick start]
-
Configuring YakChat with VoIP.ms : [https://www.yakchat.com/help/voip_ms/ YakChat & VoIP.ms]
+
YMCS Administrator guide : [https://support.yealink.com/en/portal/docDetail?documentCode=853fc60a2e2b46f1 Admin guide]
-
Help center: [https://www.yakchat.com/yakchat-help-center-get-answers-fast/ YakChat Help Center]
+
Help center: [https://support.yealink.com/en/portal/docList?archiveType=document&productCode=919ab99afd5b991c Yealink Help Center]

Latest revision as of 01:13, 6 June 2023

Yealink logo.png


Yealink provides the Yealink Management Cloud Service (YMCS) to simplify the process of managing Yealink video and voice communication endpoint devices.

YMCS delivers a host of capabilities and integrated functionality to enhance the user experience and to increase user adoption rates while consolidating customers under a cloud management platform.


Contents

Login into your YMCS

To log in, go to YMCS Login

There, enter the username and password provided by Yealink to access the platform.

Once you're logged you'll get access to the dashboard and to all the options available to configure your cloud based platform.

Login YMCS.png

Creating a Site

One of the first things you need to do when configuring the YMCS is set up the site according to the organizational structure of your company.

For this, head to Site Management - Add Site.

There you only need to assign a name, a parent site (if there's one) and a description for your own use. Click on Ok when done.

  Optionally, you can add the IP address of the site.
YMCS Site Management - Adding new site.png

Adding Accounts

The next step is adding the SIP accounts that will be used to link your devices with VoIP.ms. Make sure to have created the sub-accounts from your VoIP.ms customer portal at Sub Accounts>>Manage Sub Accounts.

To set up the account in the YMCS, go to Account Management, click on + Add Account and select Add SIP Account. Then, set this up as follows:

  1. Site: Select the site where the account belongs
  2. Register Name: This will be the sub-account username (E.g. 100000_SubAccount)
  3. Username: Same as the Register Name
  4. Password: The password of the sub-account you are adding
  5. Label: Any label you would like to assign to this account
  6. Display Name: Enter the name that you want to display on the outbound calls made from this account
 * IMPORTANT:
  - We suggest entering your outbound Caller ID Name must be in CAPITAL LETTERS. This will appears more clearly/visible on some devices.
  - You must NOT use any special characters, they will not be displayed. 
  - Use Max 15 characters, spaces included. Regular Canadian providers will not display more than 15 characters. We suggest shrinking or adapting your caller ID. 
  - Spaces are allowed in a caller id name.
YMCS Account Management - Add Account p1.png

Adding SIP Devices

After the SIP devices are connected to YMCS for enterprise, you need to add the devices to the platform, and then you can do the configuration or other operations.

To add a device, in the platform go to Device Management, click on Phone Device and then on Add Device. You will need the following information to add it:

  1. Device name: Assign a name to the device
  2. Site: Select the site the device belongs to
  3. Model: Search the model of the device you're adding and select it from the list
  4. MAC: Enter the MAC address. You can see it in the label on the back of the device
  5. Machine ID: Enter the Machine ID. You can see it in the label on the back of the device
  6. Bind Account: Add to the device the SIP Accounts that will be used on it
YMCS Device Management - Phone Device - Add Device.png

Device Configuration

To ensure your phones have the proper configuration to work with VoIP.ms you must create templates for the models of the devices that will be part of your sites from the section Device Configuration>>Site Configuration. From there, add a template to define the settings your devices will use.

Codecs

For better Audio Quality we recommend using the codec G.722. This should be enabled from your customer portal too, in the Sub Account settings.

YMCS Codecs configuration.png

Register

To keep the registration on your devices alive, is recommended to set a Server Expiration time to 120 seconds and enable NAT.

YMCS Server Expires.png

Guide Links

How to use YMCS (Detailed guide): Yealink Knowledgebase

YMCS Quick Start guide : Quick start

YMCS Administrator guide : Admin guide

Help center: Yealink Help Center

Personal tools
Namespaces
Variants
Actions
VoIP.ms Wiki
Guides 🇨🇦
Guías 🇲🇽