Samples for the bandwidth java sdk
Clone or download
Pull request Compare This branch is 12 commits ahead, 6 commits behind Bandwidth:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Java Bandwidth XML Examples

This project shows how a two step flow works in BAML technology.

The flow starts in /mainmenu url.

Once you configure this url in a Bandwidth application as callbackurl for incoming calls, or sets this url and callback url when creating an outgoing call, Bandwidth will do a get into this url and gets the xml content that has a set of commands that will be interpreted by the platform.

After /mainmenu is executed, flow is redirected to /transfer url when another set of commands are executed.

You'll need the following prereqs to run these:

You'll need a Bandwidth Application Platform account ( You'll need Maven installed ( And, of course, you'll need the jdk installed (

Now we want to deploy it to a running web server. The steps to deploy to Heroku and AWS are included below.

Standalone deployment

You can test the app locally just to check xml output.

You can run mvn clean jetty:run

And once jetty is started, access via browser url:


You are going to see the expected xml output.

Heroku Deployment

For the Heroku deployment, you'll first need to ensure that you have a Heroku account and that the Heroku toolbelt has been installed for your environment (

The steps to deploy the example app to Heroku are:

  1. Set up the git repo
  2. Create a new Heroku app
  3. Configure the Heroku app
  4. Push the project to Heroku

Step 1 - Set up the git repo

From the java-bandwidth-examples directory

git init
git add .
git commit -m "my bandwidth example"

Step 2 - Create a new Heroku app

heroku apps:create
git remote add heroku

Step 3 - Push the project to heroku

git push heroku master
heroku ps:scale web=1

You can now verify that the app is successfully deployed -

heroku logs -tail --app <heroku-app-name> 

And verify the app is running heroku open

Now you need to setup the app url /mainmenu into Bandwidth UI application callback url, or create an outgoing call having callback url point to your app url.

To setup the phone number see the Routing the Phone Number section below.

AWS Installation

For the AWS installation, you'll need to have an AWS account and be signed into the AWS Management Console

The steps to deploy the example app to AWS EC2 are:

  1. Create an AWS EC2 instance with Tomcat
  2. Copy the example war file to the EC2 instance
  3. ssh to the EC2 instance
  4. Move the war to the Tomcat webapp directory
  5. Restart tomcat
  6. Verify that the app is successfully deploy

Step 1. Create an AWS instance with Tomcat installed. For this example we’ll use a Tomcat/Ubuntu instance by Openlogic (

Step 2. Once your instance is up copy the bandwidth-xml-examples-1.0-SNAPSHOT.war from your local machine to the EC2 instance -

scp -i <key-pair-file>.pem <local path to examples dir>/java-bandwidth-examples/target/bandwidth-sdk-examples-1.0-SNAPSHOT.war ubuntu@<ec2-url>:bandwidth-sdk-examples-1.0-SNAPSHOT.war

Step 3. Log in to the EC2 instance (see AWS console for exact connect string)

ssh -i <key-pair-file>.pem ubuntu@<ec2-url> 

Step 4. Move the bandwidth-xml-examples-1.0-SNAPSHOT.war file to the tomcat webapps directory -

sudo mv bandwidth-xml-examples-1.0-SNAPSHOT.war /var/lib/tomcat7/webapps

Step 5. Restart tomcat

sudo /etc/init.d/tomcat7 restart

Step 6. Verify that the app is successfully deployed

tail -f /var/log/tomcat7/catalina.out 

Now Verify the app is running - in a browser type the url /mainmenu

To setup the phone number see the Routing the Phone Number section below.

Routing the Phone Number

Now that the app is deployed, we want it to handle all inbound phone calls. To do that we'll want to:

  • Provision a phone number on the app platform

  • Create an Application and associate it with the phone number

  • Provisioning a phone number on the app platform

    Log in to the App Platform ( Go to the My Numbers tab and select Get New Numbers Fill in the form for a number in your area and click the Search button Select one of the numbers and click the Get Numbers button

  • Creating an Application and associating the phone number with it

    Go to the My Apps tab and click the Create New link Fill in the name and the Call URL field, using the following: Click the Save button Select the number you provisioned Click the Add Numbers button

Now if you call the number, it will be routed to the demo app. You can trace the call flow in the log output of your app.