webdialer-docs

Getting Started

WebDialer Service Activation

By the default, the WebDialer service is not activated on a new CUCM install. WebDialer service activation is controlled in the CUCM Serviceability admin pages.

For WebDialer service activation and redirector/cluster configuration details, see the CUCM Feature Configuration Guide.

Accessing the WebDialer API from your application or with a testing tool, such as SoapUI, requires sending a request to the Cisco WebDialer node where the Cisco WebDialer service is running, using the following URLs:

WebDialer API Endpoints

  • SOAP: https://[cucm_host]:8443/webdialer/services/WebdialerSoapservice70
  • HTML: https://[cucm_host]:8443/webdialer/Webdialer

For applications serving multiple Cisco Unified CM clusters, WebDialer can determine an end-user's home cluster in order to place the click-to-dial call correctly. This is accomplished for the SOAP implementation using the <isClusterUserSoap> request, and performed automatically for the HTML implementation via the WebDialer Redirector service.

SOAP Client Application Workflow

  • Obtain the SOAP Webdialer service URL (for example, https://[cucm]:8443/webdialer/services/WebdialerSoapservice70). This is typically pre-configured in the application.

  • Obtain the target phone number and the end-user's username/password credentials (or the credentials of an application-user with the 'Standard EM Authentication Proxy Rights' role), typically using the application UI.

  • Send a <getProfileSoap> (supports proxy) or <getProfileDetailSoap> request, which returns a listing of the user's available phone devices/lines.

  • Select the desired device profile, for example through application
    interaction with the user.

  • Send a <makeCallSoap> request to the configured WebDialer service URL, including the credentials, target phone number, and device/line
    information.

Multi-cluster SOAP Client Application Workflow

  • Obtain a list of WebDialer service URLs for each cluster. This is
    typically pre-configured in the application.

  • Obtain the target phone number and the end-user's username/password credentials (or the credentials of an application-user with the 'Standard EM Authentication Proxy Rights' role), typically using an application UI.

  • For each WebDialer service URL, send an <isClusterUserSoap> request specifying the end-user's username, until a true result is found - use this WebDialer URL for the subsequent requests, as below.

  • Send a <getProfileSoap> (supports proxy) or <getProfileDetailSoap> request, which returns a listing of the user's available phone devices/lines.

  • Select the desired device profile, for example through application interaction with the user.

  • Send a <makeCallSoap> request to the configured WebDialer service URL, including the credentials, target phone number, and device/line information.

Note: Applications may wish to persist the end-user's phone/line preference and home cluster WebDialer service URL for future operations.

Browser-Based HTML Client Application Workflow (Single-Cluster or Multi-Cluster)

  • Obtain a WebDialer service URL from any node, e..g the Publisher. If the WebDialer Redirector service is configured for multi-cluster use, additional WebDialer service URLs are not needed.

  • The browser application opens the WebDialer HTML service URL (typically by launching a pop-up window), specifying the
    target phone number.

  • The WebDialer service on Cisco Unified CM will then determine the
    end-user's home cluster, and reply with a new HTML page providing a
    user-interface for viewing/selecting the desired device/line,
    launching the call, and optionally ending the call.

  • The WebDialer service includes a cookie in the HTML response, which will cache the user login session and device preferences, used automatically for any subsequent requests.

Note: The HTML user-interface for selecting device/line and launching the call is hosted by CUCM and is not customizable. The duration of the End Call dialog is configurable in the WebDialer service parameters.

Next