Ruby Voice Calling Quickstart

Build a simple Ruby application that answers a call and plays a message to the caller.

👍

You're ready for this Quickstart if you've got the following:

A free trial account
A registered application
A configured FreeClimb Number
Your tools and language installed

Clone Your Sample App

To help you get started we've put together a library of sample applications. For this Quickstart, clone the repository for Ruby Getting Started Tutorial using Github's interface or git in the command line.

git clone https://github.com/FreeClimbAPI/Ruby-Getting-Started-Tutorial.git

You can access the full sample app library through your Dashboard or the FreeClimbAPI Github repositories.

Make Your Local Server Publicly Accessible

The fastest way to start testing your FreeClimb application is to temporarily make your local server publicly accessible through a tunneling service. We'll use Ngrok to do this. Start by downloading Ngrok. Unzip the file to install, then open your terminal and navigate to the directory where you've unzipped Ngrok. Use the following command to start a HTTP tunnel on port 80.

./ngrok http 80

Once you run Ngrok you should receive a response with a public URL, that looks something like this:

ngrok by @inconshreveable

Tunnel Status                 online
Version                       2.0/2.0
Web Interface                 http://127.0.0.1:4040
Forwarding                    http://92832de0.ngrok.io -> localhost:80
Forwarding                    https://92832de0.ngrok.io -> localhost:80

Connnections                  ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00

The Forwarding URLs point to your local server. Save the URLs and go on to the next step.

Configure Your Application's Endpoints

Now that you've got a public URL you're ready to configure your application's endpoints. We'll be configuring the voiceUrl using your Ngrok URL and the route reference /voice.

Go to the Apps page in your Dashboard. You should see your registered FreeClimb app.

Your Apps page with your registered app

Open its App Config, and you'll see its application ID, alias, and some options for URL configuration. Enter your Ngrok URL into the voiceUrl field, and add the route /voice at the end of the URL.

https://YOUR-URL.ngrok.io/voice

When you're done the App Config should look something like this:

Example of a completed app config

Save your updated App Config.

Experience Your App

Once you've updated your App Config you're all ready to run your app! Run the application with the command:

ruby server.rb

Once the app is running, dial your configured FreeClimb number. If everything is set up right you should hear the message, "Hello, World!" and then the call will end.

Congratulations! You've just made your first voice calling application!

Next Steps

For a more detailed explanation of the code used, see How to Accept an Incoming Call.

Updated 5 months ago

Ruby Voice Calling Quickstart


Build a simple Ruby application that answers a call and plays a message to the caller.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.