Show Hide

 

Feedback

  • Contents
 

REST API Configuration

The Interaction Media Server REST API is unavailable by default. To enable and use the REST API, you must first provide a user name and password.

To enable REST API on an Interaction Media Server

  1. From a personal computer or the Interaction Media Server itself, open a web browser and navigate to the URL address and port number of the Interaction Media Server web interface. See the following example for the format of specifying this URL address: http://mediaserver1.mydomain.com:8084/

    Note:

    Packaged Interaction Media Servers use HTTP port 8083. Software-only installations of Interaction Media Server default to HTTP port 8084.

  2. Log on to the Interaction Media Server configuration webpage with the administrative user ID and password. The Status-About page appears.

  3. In the upper right corner, click the Config icon. The Config-Servers page appears.

  4. On the left side of the page, click the Administration tab. The Config-Administration page appears.

  5. Using the following boxes in the Change REST API Credentials area of the page, to supply credentials that this Interaction Media Server requires for all REST API actions:

    • New User Name

    • New Password

    • Confirm New Password

    Note:

    You can define only one set of credentials for the REST API. The credentials do not expire.

  6. Click Apply. Interaction Media Server securely stores the credentials in the Windows Registry of the host computer.

  7. In the REST API area of the page, click Enable.

  8. To use the secure HTTPS protocol for the REST API, set the following parameters on the Config-Parameters page of the Interaction Media Server web interface to a value of true:

    • Recording Retrieval Use Mutual Authentication

    • Recording Retrieval HTTPS Required

Note:

Genesys recommends that you use all available security features in your CIC environment. However, you are responsible for generating and installing HTTPS certificates, and configuring your network to ensure successful TLS protocol communications between the Interaction Media Server REST API and any entities that attempt to interact with it. Genesys does not provide technical support for connectivity or authentication issues with the Interaction Media Server REST API.