Build a communication widget

In this tutorial, we demonstrate how to build a Hello World! communication widget that can be hosted on Dynamics 365 Channel Integration Framework.

Prerequisites

  • Visual Studio 2017.
  • A valid Microsoft Azure subscription is required to publish the sample app to Azure.

Note

If you don't have an Azure subscription, create a free account.

Create a Hello World! application

  1. Open Visual Studio 2017, and select File > New > Project to create a new project.

  2. Select the ASP.NET Web Application (.NET Framework) template for your project, and add any name to it.

Select ASP.NET Web Application (.NET Framework).

  1. Select the MVC template for your application, and make sure that authentication is set to No Authentication.

    Select MVC template for your application.

    You can choose any other template for your ASP.NET application.

  2. Now view the files in Solution Explorer. Expand Views > Home, and open the Index.cshtml file.

    Open Index.cshtml file from Solution Explorer.

  3. Replace the HTML code in the Index.cshtml file with the following code:

<!DOCTYPE html>
<html>
<body>
  <br /><br />
  <p>Hello World!</p>
</body>
</html>
  1. Run this HTML file using Microsoft Edge or Google Chrome to test and debug.

    The webpage should look like this when you run it in your browser:

    Run app in browser.

Publish and configure the widget

  1. To publish the sample widget you created, follow the steps in Publish sample app to Azure. You might also want to read this Azure tutorial on how to create and publish an ASP.NET web app in Azure: Create an ASP.NET Framework web app in Azure. Once the wizard has published the app on Azure, it provides a site URL that you can use to access your hosted web app.
    When you select the site URL, it opens the same web app that we saw earlier while debugging our web app in Visual Studio.

  2. To configure the widget in your Dynamics 365 instance, follow the steps described here: Configure sample app in Dynamics 365.

After the preceding steps are completed, open one of the Unified Interface apps that you selected while configuring the widget in Dynamics 365 Channel Integration Framework, and you'll see the communication widget in the right-side panel. To open one of your selected Unified Interface apps, go to https://[Organization URI]/apps.

The published widget should look like this.

Published sample widget in Unified Interface apps.

Now, proceed to the next section of this walkthrough that shows how you can search and open a record in Dynamics 365 on an incoming call.

How to check if Channel Integration Framework 1.0 is ready for communication

You can check if Channel Integration Framework 1.0 is ready by invoking CIFInitDone event. CIFInitDone event is raised by Channel Integration Framework library after the Channel Integration Framework is loaded. This event determines if the Channel Integration Framework APIs are ready for communication. More information: Events

See also

Search and open records on an incoming conversation
Sample code for softphone integration
Create an ASP.NET Framework web app in Azure
Frequently asked questions