UCM63xx/A Cloud IM Server – Admin Guide

  • Updated on September 14, 2022

Overview

Cloud IM services with UCM devices provide cloud communication services with high performance, large storage, multi-functions, etc.

  • Resolved the problem of limited storage space and performance of UCM devices and ensure that UCM devices are used for calling services. Cloud IM system provides unified communication services such as instant messages. Both telephone calls and instant message performance will be guaranteed.
  • Unified management for the UCM devices across regions and satisfied the requirements of communication within the enterprise in different regions.
  • With UCM Cloud IM service, all Wave clients will use the Cloud IM system, and the chat data will be stored in the cloud system.
Note

Users can only use the Cloud IM services after logging in to the Wave application. The Wave client download address is: https://fw.gdms.cloud/wave/download/

Cloud IM Usage Scenario

UCM under External Network

The enterprise user can use the Wave application to make calls or chat from anywhere on the public network. The enterprise user can use the calling capabilities in the UCM and the Cloud IM services in the cloud system.

Figure 1: Case Scenario – UCM under External Network

UCM under Internal Network

The enterprise user can only use the Wave application to make calls or chat on the internal network of the enterprise. The enterprise user can use the calling capabilities in the UCM and the Cloud IM services in the cloud system.

Requirements: UCM device can connect to Cloud IM server through the public network.

Figure 2: Case Scenario – UCM under Internal Network

UCM under Internal/External Network

The enterprise user can use the Wave application to make calls or chat, no matter under internal network of the enterprise, or under the public network at anywhere. The user can make outbound calls through the UCMRC plan, and chat through Cloud IM services between the internal network and the external network.

Figure 3: Case Scenario – UCM under Internal/External Network

Multiple UCM Devices Share One Cloud IM Server

If the enterprise has multiple UCM devices, and it requires them to chat with each other, create a group chat, make calls, and schedule meetings, the enterprise user needs to configure the Cloud IM service to the UCM devices to satisfy the communication requirements across different regions.

Figure 4: Case Scenario – Multiple UCM Devices Share One Cloud IM Server

Enable Cloud IM Service

The user needs to purchase a UCM RemoteConnect plan with the Cloud IM service before using the related features. The user can contact the distributor and view more plan details on the official website.

The user needs to associate the UCM device to the GDMS platform.

After purchasing the UCM RemoteConnect plan which contains the Cloud IM service for the UCM device, the user can enable and use the Cloud IM service.

Log in to the GDMS platform, the user needs to click Order History to access “My Plans” page.

Figure 5: Order History

On the “My Plans” page, it will display the plan information purchased for the UCM device. The user can select the Cloud IM service corresponding to the specific UCM device by clicking the button , and access the Cloud IM service editing page to enable it.

Figure 6: Edit Cloud IM Service

Enable Cloud IM

After purchasing a UCMRC plan that contains the Cloud IM service, the user needs to enable the Cloud IM service on the GDMS platform.

Note: If the user wants to disable the Cloud IM service which is currently in use and will no longer use it, the data in the Cloud IM server will be cleared after disabling it.

Region

US Region / EU Region

Note:

  • It is recommended to select the nearest region to the UCM device.

  • If the user switches to another region, the data in the Cloud IM server will be cleared.

Company Name

The user can customize the name of the company which will use the Cloud IM service.

Cloud IM Maximum Storage Space

The user can edit the maximum available storage space for the Cloud IM service.

Note:

  • The user needs to allocate some space from the cloud storage space for Cloud IM service usage.

  • The configured storage space must be larger than the space currently used by the Cloud IM service and smaller than the available cloud storage space.

Note:

  • On the UCM Devices list, the user can click to view the plan information of the selected device and enable the Cloud IM service for the specific device.
Figure 7: UCM Device – Enable Cloud IM Service

The user can click the “Save” button to enable the Cloud IM service, and the user can view the Cloud IM service domain name, service ID, and Key.

Figure 8: Cloud IM Credentials on Web Interface

The user can quickly bind the UCM device for the Cloud IM service so that the UCM device can start to apply the Cloud IM service quickly.

Figure 9: Bind UCM Device
Notes

  • The user can also copy the service ID and service key and bind the UCM device to the UCM device management platform. The user can go to the UCM Web UI 🡪 System Settings 🡪 Cloud IM interface and enter the Cloud IM involved information in the blanks. The corresponding IM data are placed in the Cloud IM external server.
  • If the UCM Cloud IM service expires, the Wave users cannot log in to the account. The chat data will also be deleted. Please renew the UCM Cloud IM service in time.

Configure Cloud IM Service for UCM

Configure Cloud IM Service for UCM through GDMS

  1. After enabling the Cloud IM service, the user can view the UCM RemoteConnect plan which has enabled the Cloud IM service on the “My Plans” page. Then, the user can click the icon and access the “Bind UCM Device” interface.
Figure 10: UCM Cloud IM Service under My Plan

  1. View the UCM devices which are bound to the UCM Cloud IM service. It allows users to add/delete devices. Please see the screenshot below:
Figure 11: Details of the UCM devices bound to the Cloud IM service

Department Name

Enter the name of the department using this UCM device so that the contact details in the Wave application can be viewed.

UCM MAC Address

Enter the MAC address of the UCM that uses the UCM Cloud IM service. It only supports the UCM devices which have been associated with the GDMS platform.

Note: For the UCM devices which have been associated with the GDMS platform, the user can only log in to the UCM management platform to configure the Cloud IM services.

Dial Prefix

The dial prefix required to dial this UCM device must be the same as the trunk dial prefix configured in the UCM. Please refer to the UCM Administration Guide for more details. For example, there are UCM A, UCM B, and UCM C. If the configured prefix of UCM B and C to dial A is 99 (configured trunk), then when the user adds UCM A, the user needs to configure the dial prefix to 99.

Table 1: Bind UCM Device Parameters

Figure 12: Outbound Rule

Note:

  • If the user adds/deletes/edits a department name, the status will show as the icon until the UCM is online and synchronized, and then the updates will be applied.
  • The bound device must have the UCM RemoteConnect plan which contains the Cloud IM service.

Configure Cloud IM Service for UCM through UCM Web UI

The user can log in to the UCM device’s Web UI 🡪 System Settings 🡪 Cloud IM and click to enable the Cloud IM service. All chat data in the Wave application will be stored in the Cloud IM server, and the data will not be stored in UCM locally anymore.

The user can also configure the Cloud IM service for the UCM device through the GDMS platform. The UCM settings will be synchronized after pushing the parameters to the UCM device.

Figure 13: Could IM Service Settings

Cloud IM Settings

Enable Cloud IM

If the user has already purchased a UCM RemoteConnect plan which contains the Cloud IM service, or the user has already purchased a Grandstream IM server, the user can configure this service. If the user does not purchase the plan or server, the setting will not take effect, and the user only can use the UCM local IM service.

Note:

After enabling the Cloud IM service, the local chat data will not be visible.

Local Proxy

If the user is using a UCM device as the IM server, to ensure that the Wave application can be used normally, it is recommended to enable this option.

Cloud IM Server Address

The user can fill the Cloud IM server address in this field with the Cloud IM server address provided by UCM RemoteConnect plan or the Grandstream IM server address.

The user can view the Cloud IM service information on the GDMS platform.

Service ID

The user can fill in the service ID of the Cloud IM server.

Key

The user can fill in the Key for the Cloud IM server.

Department Name

Enter the name of the department using this UCM device so that the contact details in the Wave application can be viewed.

Trusted User

When the user is using a UCM as the IM server, and the IM server address is an IP address, the user needs to obtain this information from the IM server.

Dial Prefix

The dial prefix required to dial this UCM device must be the same as the trunk dial prefix configured in the UCM. Please refer to the UCM Administration Guide for more details.

Table 2: Cloud IM settings

View Cloud IM Storage

With the Cloud IM service, all chat data will be stored in the storage space of this service.

Log in to the GDMS platform, the user can go to “My Plans” to find the Cloud IM service, and the user can click the button to view the service domain, service ID, service Key, and the usage of the storage space of this service.

Figure 14: Plan Details
Note

  • If the storage space for this plan is full, the user cannot send files and pictures in the chat.
  • The user needs to allocate some space from the cloud storage space for the Cloud IM service usage. The user can customize the maximum storage space used by the Cloud IM service. If there is no more available cloud storage space, the user can contact the device distributor to upgrade the UCM RemoteConnect plan to a higher-level plan to obtain more cloud storage space.

COPYRIGHT

©2021 Grandstream Networks, Inc. http://www.grandstream.com

All rights reserved. Information in this document is subject to change without notice. Reproduction or transmittal of the entire or any part, in any form or by any means, electronic or print, for any purpose without the express written permission of Grandstream Networks, Inc. is not permitted. 

The latest electronic version of this user manual is available for download here:

http://www.grandstream.com/support

Grandstream is a registered trademark and Grandstream logo is the trademark of Grandstream Networks, Inc. in the United States, Europe, and other countries.

CAUTION

Changes or modifications to this product not expressly approved by Grandstream, or operation of this product in any way other than as detailed by this User Manual, could void your manufacturer warranty.

WARNING

Please do not use a different power adaptor with your devices as it may cause damage to the products and void the manufacturer warranty.

GNU GPL INFORMATION

UCM630X firmware contains third-party software licensed under the GNU General Public License (GPL). Grandstream uses software under the specific terms of the GPL. Please see the GNU General Public License (GPL) for the exact terms and conditions of the license.

Grandstream GNU GPL related source code can be downloaded from Grandstream website from:

http://www.grandstream.com/support/faq/gnu-general-public-license/gnu-gpl-information-download

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Comment

We use cookies in order to give you the best possible experience on our website. By continuing to use this site, you agree to our use of cookies.
Accept