Unified Communications Managed API (UCMA) 3.0 is a managed-code platform that developers use to build applications that provide access to and control over Microsoft Enhanced Presence information, instant messaging, telephone and video calls, and audio/video conferencing.
The following information can be used to install and uninstall Microsoft Unified Communications Managed API (UCMA) 3.0 SDK, which is required when you develop an application using Microsoft Unified Communications Managed API (UCMA) 3.0.
Unified Communications Managed API (UCMA) 3.0 is a managed-code platform that developers use to build applications that provide access to and control over Microsoft Enhanced Presence information, instant messaging, telephone and video calls, and audio/video conferencing. In addition to text conversations, UCMA 3.0 supports speech-technology enabled voice conversations and collaboration. UCMA 3.0 supports the development of server side, middle-tier applications targeting Microsoft Lync 2010 and Microsoft Lync Server 2010. UCMA 3.0 contains a SIP stack, a media stack, and speech engines for both automatic speech recognition (ASR) as well as speech synthesis (TTS).
UCMA 3.0 can be used to add communications capabilities to your business software and processes and can be used to create outbound applications such as alerts or notifications and surveys, inbound speech-technology enabled interactive voice response applications, and automated agents known as query response bots. UCMA 3.0 API provides access to Lync Server 2010 presence information and can be used to build role agents that use Enhanced Presence information to streamline communications between people.
Advanced UCMA 3.0 scenarios can be used to develop various applications:
- Automated Call Distributors that perform skill-based routing.
- Call recording.
- Conferencing services such as conference access control.
- Custom client gateways that interface with, for example, other communications networks, Interactive Voice Response platforms, and speech servers using the Microsoft ASR and TTS engines.
Supported Operating System
Windows 7 Home Basic 64-bit, Windows 7 Home Premium 64-bit, Windows 7 Professional 64-bit, Windows 7 Ultimate 64-bit, Windows Server 2008 R2, Windows Server 2008 Service Pack 2, Windows Vista Business 64-bit edition, Windows Vista Enterprise 64-bit edition, Windows Vista Home Basic 64-bit edition, Windows Vista Home Premium 64-bit edition, Windows Vista Ultimate 64-bit edition
- UCMA 3.0 SDK is available only in a 64-bit version.
- Windows Server 2003 is not supported.
- Development is supported only in 64-bit environments.
- Microsoft Windows XP is explicitly blocked in UCMA SDK setup.
- Microsoft Windows PowerShell 2.0 RTM
Windows Server 2008 SP2 comes with PowerShell 1.0. To install PowerShell 2.0, see Windows Management Framework Core package (Windows PowerShell 2.0 and WinRM 2.0).
If you have the Community Technology Preview version of PowerShell/WinRM, you must uninstall it. Package Manager (Pkgmgr.exe) can be used to uninstall PowerShell/WinRM, as shown in the following command line: start /w pkgmgr.exe /uu:MicrosoftWindowsPowerShell
PowerShell 2.0 comes with Windows 2008 R2. Use Server Manager to enable the PowerShell 2.0 feature.
- Microsoft Visual Studio development system
- Microsoft Visual Studio 2008 SP1 or later service pack
- Microsoft Visual Studio 2010 RTM
- Microsoft .NET Framework 3.5 SP1 or later service pack
- If you have Visual Studio 2008 SP1, you might already have .NET Framework 3.5 SP1.
- On Windows Server 2008 R2, use Server Manager to install .NET Framework 3.5 SP1.
- Side-by-side installations of UCMA 3.0 SDK and Microsoft Unified Communications Managed API (UCMA) 2.0 SDK are not supported.
- When Windows Media format is installed or enabled, the computer must be restarted.
- Windows Media Format must be present if you use UCMA 3.0 to develop applications that play or record media.
- UcmaSdkSetup.exe must be run with elevated privileges.
- UCMA 3.0 Workflow SDK applications developed in Microsoft Visual Studio 2010 require .NET Framework 3.5 Service Pack 1 or later service packs. Make sure that you choose .NET Framework 3.5 in the Visual Studio 2010 menu if you are creating a UCMA 3.0 Workflow SDK application.
- If you are using Microsoft Visual Basic to create a workflow application using Visual Studio 2008 SP1 for the first time, an error might occur when you attempt to compile and run the application. The workaround is to close and then reopen Visual Studio.
The following are the hardware requirements for successful installation of UCMA 3.0 SDK.
- Typical current hardware configurations with a minimum of 2 GB of RAM are recommended for the supported operating systems.
UCMA 3.0 SDK Installation
Installed Prerequisite Components
- Download UcmaSdkSetup.exe.
- Launch UcmaSdkSetup.exe and follow the instructions to complete the installation.
Note: By default, UCMA 3.0 SDK is installed in the %Program Files%\Microsoft UCMA 3.0 directory.
The following prerequisite components are installed.
Uninstall UCMA 3.0 SDK
- Microsoft Windows Media Format Runtime
- Microsoft VC ++ 2008 Redistributable -x64 9.0.30729.4148 Package
- Microsoft VC ++ 2008 Redistributable –x86 9.0.30729.4148
- Microsoft Server Speech Platform Runtime (x64) Package
- Microsoft Server Speech Platform Runtime (x86) Package
- Microsoft Server Speech Recognition Language - TELE (en-US)
- Microsoft Server Speech Text To Speech Voice (en-US, Helen)
- Microsoft Lync Server 2010, Core Components
- Microsoft Speech Platform SDK (x64) v10.2
- Microsoft Lync Server 2010, Bootstrapper Prerequisites Installer Package
- Microsoft Unified Communications Managed API 3.0, Runtime
- Not all prerequisites appear in Programs and Features, for example, Windows Media Format Runtime.
- The principal entry in Programs and Features after installing UCMA 3.0 SDK is Microsoft Unified Communications Managed API 3.0, SDK.
- On the taskbar, click Start, and then click Control Panel.
- In Control Panel, double-click Programs and Features.
- Using the right-click menu for Microsoft Unified Communications Managed API 3.0 SDK, select Uninstall.
Uninstalling UCMA 3.0 SDK does not uninstall the prerequisite components listed earlier. These components can be uninstalled individually using Programs and Features in Control Panel.