Register by 10/16 for $250 off the on-site price.

How To Use Recording Add-ons in Ruby

In this guide we’ll cover how to combine Twilio Add-ons with Programmable Voice to use data from Twilio's partners in your Sinatra web application. Let's get started!

What’s an Add-On?

Twilio Add-ons are pre-integrated third party services that you can use with your Twilio application. Add-ons enhance the responses your application receives from Twilio by including additional data from Twilio’s partners.

In this guide we’ll cover how to combine Twilio Add-ons with Programmable Voice to use data from Twilio's partners in your Sinatra web application. The sample code in this guide will use the Twilio Ruby SDK and the Sinatra web framework. Let's get started.

Loading Code Samples...
Language
{
  "status":"successful",
  "message":null,
  "code":null,
  "results":{
    "ibm_watson_speechtotext":{
      "request_sid":"XRc82d4197bbc51d5982588ae367365a51",
      "status":"successful",
      "message":null,
      "code":null,
      "payload":[
        {
        "content_type":"application/json",
        "url":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51/Payloads/XH364bd4514b1377fd8844cd9793416131/Data"
        }
      ],
      "links":{
        "add_on_result":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51",
        "payloads":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51/Payloads",
        "recording":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40"
      }
    }
  }
}
This is a sample of the payload your application would receive when using the IBM Watson Speech to Text add-on.
Sample data from the IBM Watson Speech to Text Add-on

This is a sample of the payload your application would receive when using the IBM Watson Speech to Text add-on.

Here’s an example that uses the IBM Watson Speech to Text Add-on. The generated transcription will be pushed to the application through a callback from Twilio.


The IBM Watson Speech add-on can convert Twilio audio recordings into text using machine intelligence to combine information about grammar and language structure.

Loading Code Samples...
Language
{
  "user_token": "XRf951c9b0bce23930750991099e553b0a",
  "results":[
    {
      "results":[
        {
          "keywords_result":{},
          "alternatives":[
            {
            "timestamps":[
              ["I", 0.04, 0.28],
              ["love", 0.28, 0.71],
              ["coding", 0.74, 1.25]
            ],
            "confidence":0.782,
            "transcript":"I love coding "
            }
          ],
          "final":true
        }
      ],
      "result_index":0
    }
  ],
  "id":"b0e7a660-bcb6-11e6-8b1b-192a5f5dc12f",
  "event":"recognitions.completed_with_results"
}
This is the sample analysis that the Add-on partner provides which is included in the URL of the payload above.
Sample recording analysis from the IBM Watson Speech to Text Add-on

This is the sample analysis that the Add-on partner provides which is included in the URL of the payload above.

See the Add-ons Catalog for the complete list of available add-ons.

Enabling Add-ons in the Twilio Console

The first stop in using an add-on is your Twilio Console. Log in and navigate to the Add-ons page within the Marketplace section.

Add-ons catalog

Then choose on the add-on you want to enable and click the “Install” button. After accepting the Terms of Service, it will be installed on your account. In this example, we’ll use the IBM Watson Speech to Text Add-on.

IBM Watson Speech to Text install Add-on

Once installed, select the checkbox for the recording method you are using (see the different recording methods here). In our example to follow, we would only need the "Record Verb Recordings".  Set the “Callback URL” and “Callback Request Method” as appropriate for your public server URL (instructions below). Pro Tip: you can quickly inspect what Twilio will send to your callback URL using tools like PostBin before you actually set up your server.

IBM Watson Speech to Text Configure tab

 Now we’re ready to use the extra data from our add-on in our Sinatra application.

Using Add-on data in your application

Twilio will include data from all of your add-ons in an “AddOns” field on HTTP requests it makes to your application. The following example demonstrates how to access add-on data within your Sinatra application.

Loading Code Samples...
Language
SDK Version:
  • 5.x
require 'sinatra'
require 'twilio-ruby'
require 'json'
require 'httparty'

post '/voice' do
  Twilio::TwiML::VoiceResponse.new do |r|
    r.say(message: 'Hi! I want to know what do you think about coding.')
    r.record(maxLength: '10', action: '/recording')
    r.hangup
  end.to_s
end

post '/recording' do
  recording_url = params['RecordingUrl']
  puts recording_url

  Twilio::TwiML::VoiceResponse.new do |r|
    r.say(message: 'Thanks for howling... take a listen to what you howled.')
    r.play(url: recording_url)
    r.say(message: 'Goodbye.')
  end.to_s
end

post '/callback' do
  add_ons = JSON.parse(params['AddOns'])

  unless add_ons['results'].key? 'ibm_watson_speechtotext'
    return 'Add Watson Speech to Text add-on in your Twilio console'
  end

  payload_url = add_ons['results']['ibm_watson_speechtotext']['payload'][0]['url']

  account_sid = ENV['TWILIO_ACCOUNT_SID']
  auth_token = ENV['TWILIO_AUTH_TOKEN']
  resp = HTTParty.get(
    payload_url,
    basic_auth: { username: account_sid, password: auth_token }
  )

  results = resp['results'][0]['results']
  transcripts = results.map { |item| item['alternatives'][0]['transcript'] }

  return transcripts
end
Use the IBM Watson Speech to Text add-on to get a transcription of a recording
Use IBM Watson Speech to Text Add-on

Use the IBM Watson Speech to Text add-on to get a transcription of a recording

This application gets the transcription for the recorded call from IBM Watson Speech to Text Add-on we configured in the Twilio console. You can find a detailed specification of the data structure for an individual add-on within that add-on's page in the catalog.

And that’s it! Try giving your application a call to see your add-on in action. If you've never received a Twilio phone call with Ruby before, check out our guide on that topic.

Where to next?

We focused on the IBM Watson Speech to Text Add-on in this guide, but you can just as easily use any of the add-ons available in the catalog in your Twilio Console.

Check out the full Add-Ons API Reference documentation if you want to learn more about how add-ons work, or even how to publish your own.

Carlos Villavicencio
Jose Oliveros
Agustin Camino
Andrew Baker
Kevin Whinnery
Kat King
Ricky Robinett
David Prothero
Stephen Wai
Rob Spectre
Hector Ortega

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

Loading Code Samples...
{
  "status":"successful",
  "message":null,
  "code":null,
  "results":{
    "ibm_watson_speechtotext":{
      "request_sid":"XRc82d4197bbc51d5982588ae367365a51",
      "status":"successful",
      "message":null,
      "code":null,
      "payload":[
        {
        "content_type":"application/json",
        "url":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51/Payloads/XH364bd4514b1377fd8844cd9793416131/Data"
        }
      ],
      "links":{
        "add_on_result":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51",
        "payloads":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40/AddOnResults/XRc82d4197bbc51d5982588ae367365a51/Payloads",
        "recording":"https://api.twilio.com/2010-04-01/Accounts/AC597d02bf69de79f8f411f289ac211a0d/Recordings/REab85c1c2860471abf040b545c4e5aa40"
      }
    }
  }
}
{
  "user_token": "XRf951c9b0bce23930750991099e553b0a",
  "results":[
    {
      "results":[
        {
          "keywords_result":{},
          "alternatives":[
            {
            "timestamps":[
              ["I", 0.04, 0.28],
              ["love", 0.28, 0.71],
              ["coding", 0.74, 1.25]
            ],
            "confidence":0.782,
            "transcript":"I love coding "
            }
          ],
          "final":true
        }
      ],
      "result_index":0
    }
  ],
  "id":"b0e7a660-bcb6-11e6-8b1b-192a5f5dc12f",
  "event":"recognitions.completed_with_results"
}
SDK Version:
  • 5.x
require 'sinatra'
require 'twilio-ruby'
require 'json'
require 'httparty'

post '/voice' do
  Twilio::TwiML::VoiceResponse.new do |r|
    r.say(message: 'Hi! I want to know what do you think about coding.')
    r.record(maxLength: '10', action: '/recording')
    r.hangup
  end.to_s
end

post '/recording' do
  recording_url = params['RecordingUrl']
  puts recording_url

  Twilio::TwiML::VoiceResponse.new do |r|
    r.say(message: 'Thanks for howling... take a listen to what you howled.')
    r.play(url: recording_url)
    r.say(message: 'Goodbye.')
  end.to_s
end

post '/callback' do
  add_ons = JSON.parse(params['AddOns'])

  unless add_ons['results'].key? 'ibm_watson_speechtotext'
    return 'Add Watson Speech to Text add-on in your Twilio console'
  end

  payload_url = add_ons['results']['ibm_watson_speechtotext']['payload'][0]['url']

  account_sid = ENV['TWILIO_ACCOUNT_SID']
  auth_token = ENV['TWILIO_AUTH_TOKEN']
  resp = HTTParty.get(
    payload_url,
    basic_auth: { username: account_sid, password: auth_token }
  )

  results = resp['results'][0]['results']
  transcripts = results.map { |item| item['alternatives'][0]['transcript'] }

  return transcripts
end