How to: Start an automation audio conversation

Article
06/11/2018

Learn how to use Microsoft Lync 2013 SDK to automate opening a new Microsoft Lync 2013 conversation window to host an audio conversation with another Lync 2013 client.

Applies to: Lync 2013 | Lync Server 2013

In this article
Prerequisites
Create an audio conversation application
Code examples: Automation conversation starter
Additional resources

Prerequisites

The prerequisites for starting an automation audio conversation are as follows:

Microsoft Lync 2013 must be installed and running on the development computer.
You must have sign-in credentials for Microsoft Lync Server 2013.
Microsoft Lync 2013 SDK must be installed on the development computer.

Core concepts to know

Topic	Description
Conversation window automation in Lync SDK	Describes the scope of automation through the Microsoft.Lync.Model.Extensibility namespace.

Create an audio conversation application

Conversations can only be started when the user is signed in to Lync 2013. Read about How to: Sign a user in to Lync and be sure that your application logic provides this capability before adding an audio conversation to your UI.

To start an audio conversation, get a Microsoft.Lync.Model.Extensibility.Automation object, create IEnumerable objects to contain a URI or a phone number, set instances of Microsoft.Lync.Model.Extensibility.AutomationModalities and Microsoft.Lync.Model.Extensibility.AutomationModalitySettings, and then call the Automation.BeginStartConversation method.

To create the audio conversation application

Sign in to Microsoft Lync 2013.
In Microsoft Visual Studio, create a new Windows Forms application.
Select .NET Framework 3.5 or 4.0 as the target framework.

For more information, see How to: Target a Specific .NET Framework.
Add a reference to the assembly Microsoft.Lync.Model.

In Form1.cs, add the following using statement.

using Microsoft.Lync.Model;
using Microsoft.Lync.Model.Extensibility;

In the command button click event handler, add the following code.

// Create a generic List object to contain the URI to call.
// Edit this to provide a valid URI.
List<string> participantUri = new List<string>();
participantUri.Add(GetSip.Text);

// Start the conversation.
LyncClient.GetAutomation().BeginStartConversation(
    AutomationModalities.Audio,
    participantUri,
    null,
    (ar) =>
    {
        try
        {
            ConversationWindow newWindow = LyncClient.GetAutomation().EndStartConversation(ar);
        }
        catch (OperationException oe) { MessageBox.Show("Operation exception on start conversation " + oe.Message); };
    },
    null);

Build and run the application.
Listen to the ringtone from Microsoft Lync 2013 on the calling computer and see the accept call request on the computer you called.

Code examples: Automation conversation starter

The following sample is a WPF window that accepts a SIP URI and automates the starting of a Lync 2013 conversation window that hosts a conversation between the local user and the user or telephone number whose URI the input value is resolved to.

The following example declares a WPF window that accepts a string URI and shows a command button that opens a new conversation window with a person or a PSTN phone.

<Window x:Class="AutomationPhoneCall.Page1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="100" Width="300">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="140"/>
            <ColumnDefinition Width="80*"/>
        </Grid.ColumnDefinitions>
        <StackPanel Grid.Column="0">
            <TextBox Name="GetSip" Text="enter SIP" Margin="20,20,20,0"/>
        </StackPanel>
        <Button Grid.Column="1" Name="Go_Button" Content="Call" Margin="10,10,10,10" Click="Go_Button_Click"/>
    </Grid>
</Window>

The following example automates a new Lync 2013 conversation window with the audio modality and connects to the user that was resolved by the supplied SIP URI.

using System.Collections.Generic;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using Microsoft.Lync.Model;
using Microsoft.Lync.Model.Extensibility;

namespace AutomationPhoneCall
{
    /// <summary>
    /// Interaction logic for Page1.xaml
    /// </summary>
    public partial class Page1 : Window
    {
        public Page1()
        {
            InitializeComponent();
        }

        private void Go_Button_Click(object sender, RoutedEventArgs e)
        {
            if ( GetSip.Text.Length == 0)
            {
                return;
            }
            List<string> participantUri = new List<string>();
            participantUri.Add(GetSip.Text);
            LyncClient.GetAutomation().BeginStartConversation(
                AutomationModalities.Audio,
                participantUri,
                null,
                (ar) =>
                {
                    try
                    {
                        ConversationWindow newWindow = LyncClient.GetAutomation().EndStartConversation(ar);
                    }
                    catch (OperationException oe) { MessageBox.Show("Operation exception on start conversation " + oe.Message); };
                },
                null);
        }
    }
}