Log and display processed messages (SipSnoop sample)

Lync 2013

Learn about the Microsoft Lync Server 2013 SDK SipSnoop sample application.

Last modified: August 16, 2013

Applies to: Lync 2013 | Lync Server 2013

Note Note

By default, the SipSnoop application is copied to the %progfile%\Microsoft Lync Server 2013\SDK\Samples\SipSnoop folder. SipSnoop and related code samples can also be downloaded from the MSDN Code Gallery.

The SipSnoop sample application that is distributed with the Lync Server 2013 SDK shows how to receive all messages that the Microsoft Lync Server 2013 computer processes. The application displays the messages in a UI and maintains statistics about various SIP messages such as number of requests and processed responses.

The application uses two application manifests, SipSnoop.am and SipSnoop2.am, to handle the following tasks.

  • SipSnoop.am is the basic manifest that handles the following application features:

    • Uses the <allowRegistrationBeforeUserServices/> element to configure the UserServices application run time.

    • Configures server run time through <serverFilter roles="ALL"/>.

    • Uses the <requestFilter methodNames="ALL"/> and <responseFilter reasonCodes="ALL"/> elements to configure how the application receives each request, response, and the corresponding proxy.

  • SipSnoop2.am uses the DispatchNotification function instead of the Dispatch function.

If necessary, copy the %progfile%\Microsoft Lync Server 2013\SDK\Samples\SipSnoop folder to a Lync Server 2013 computer on which the application runs.

To build the application

  1. Open a command console in a user account that has elevated permission.

  2. Open the %progfile%\Microsoft Lync Server 2013\SDK\Samples\ folder.

  3. Use the following command to build the application.

    Compile SipSnoop

To run the application

  1. Log on to a Lync Server 2013 RTC Server Applications local security group account.

  2. Register the application by running the following commands in a Lync Server Management Shell window.

    Note Note

    <lync.Server.Fdqn> is the placeholder for the fully qualified domain name for the test server.

    new-csServerApplication -uri " http://www.microsoft.com/LC/SDK/Samples/SipSnoop" -identity "service:registrar:<lync.Server.Fdqn>/SipSnoop" -critical $false -priority 6 -enabled $true


    The application must be registered before the managed code is invoked.

  3. Start the application by using the SipSnoop.exe program.