jtapi-samples

Overview

Sample Java programs demonstrating usage of the Cisco JTAPI API for call control.

Visit the DevNet JTAPI Site

Available samples

• makeCall - basic make-call example.

• sendData - Opens a phone and performs a CiscoTerminal.sendData() request to send an IP Phone Services 'Hello World' message to the phone's display.

• superProvider_deviceStateServer - Demonstrates using CiscoProvider.createTerminal() to dynamically create a terminal by device name using the 'Superprovider' feature, then retrieves and monitors the device for device-side status changes using the 'Device State Server' feature.

• dialViaOffice - Implements a 'dial via office' senario, where a phone calls a CTI Route Point, which makes a new outbound call to a target DN, and then redirects both calls to a CTI Port which transfers the two calls together.

• conference - Implements a 3-way ad hoc conference scenario.

• playmedia - Answer an inbound call on a CTI Port, then play an audio file using the gstreamer-java framework (see GStreamer Downloads to install - present by default in Ubuntu Linux.)

Requirements

• OpenJDK 8

• Apache Maven 3.6.3

• Visual Studio Code with the MS Extension Pack for Java

• A working Cisco Unified Communications Manager environment:

  • An CUCM application-user or end-user username/password, with the following roles:

    • Standard CTI Allow Control of Phones supporting Connected Xfer and conf

    • Standard CTI Allow Control of Phones supporting Rollover Mode

    • Standard CTI Enabled

    • Standard CTI Allow Control of all Devices

  • One (or three, to try all sample scenarios) CTI supported phone devices (includes Cisco IP Communicator and Jabber soft phones), each configured with one directory number, each associated to the CUCM user.

    Note, ensure directory numbers have Allow Control of Device from CTI enabled

  • One CTI Route Point and one CTI Port, each configured with one DN and associated to the CUCM user.

Tested With:

• Ubuntu 22.04
• OpenJDK 8 / 11
• Maven 3.6.3
• CUCM 11.5 / 12.5 / 14

Getting started

1. Make sure you have OpenJDK 11 installed, java is available in the path, and $JAVA_HOME points to the right directory:

   $ java -version
   openjdk version "1.8.0_342"
   OpenJDK Runtime Environment (build 1.8.0_342-8u342-b07-0ubuntu1~22.04-b07)
   OpenJDK 64-Bit Server VM (build 25.342-b07, mixed mode)

   $ echo $JAVA_HOME
   /usr/lib/jvm/java-8-openjdk-amd64

2. Open a terminal and use git to clone this repository:

   git clone https://github.com/CiscoDevNet/jtapi-samples.git

3. Open the Java project in Visual Studio Code:

   cd jtapi-samples
   code .

4. Configure the Java runtime for the project (see Configure Java Runtime):

   Open (or create) .vscode/settings.json

   Sample configuration

   {
       "java.configuration.runtimes": [
           {
               "name": "JavaSE-1.8",
               "path": "/usr/lib/jvm/java-8-openjdk-amd64"
           }
       ]
   }   

5. Edit rename .env.example to .env, and edit to specify environment variable config for the samples you wish to run.

6. Finally, to launch the sample in VS Code, select the Run panel, choose the desired Launch... option from the drop-down in the upper left, and click the green 'Start Debugging' arrow (or hit F5)

   

Notes

1. In this project, the 11.5, 12.5 and 14 versions of the JTAPI Java library have been deployed to the project's local Maven repo (in lib/), with 14 being the configured version.

   If you want to use another deployed version, modify pom.xml to specify the desired JTAPI version dependency. Modify <version>:

   <dependency>
       <groupId>com.cisco.jtapi</groupId>
       <artifactId>jtapi</artifactId>
       <version>12.5</version>
   </dependency>

2. If you want to deploy another JTAPI version in the project:

   • Download and install/extract the JTAPI plugin from CUCM (Applications / Plugins)

   • From this repository's root, use Maven to deploy the new version of jtapi.jar to the local repo. You will need to identify the full path to the new jtapi.jar installed above:

     mvn deploy:deploy-file -DgroupId=com.cisco.jtapi -DartifactId=jtapi -Dversion={version} -Durl=file:./lib -DrepositoryId=local-maven-repo -DupdateReleaseInfo=true -Dfile={/path/to/jtapi.jar}

     Note: be sure to update {version} and {/path/to/jtapi.jar} with your actual values

3. JTAPI configuration - e.g. trace log number/size/location and various timeouts - can be configured in jtapi_config/jtapi.ini (defined as a resource in pom.xml)

4. As of v14, the Cisco jtapi.jar does not implement the Java Platform Module System (JPMS). See this issue for more info.