The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
Add this line to your application's Gemfile:
gem 'plivo', '>= 4.26.0'
And then execute:
$ bundle
Or install it yourself as:
$ gem install plivo
For features in beta, use the beta branch:
$ gem install plivo --pre
If you have the 0.3.19
version (a.k.a legacy) already installed, you may have to first uninstall it before installing the new version.
To make the API requests, you need to create a RestClient
and provide it with authentication credentials (which can be found at https://console.plivo.com/dashboard/).
We recommend that you store your credentials in the PLIVO_AUTH_ID
and the PLIVO_AUTH_TOKEN
environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:
client = RestClient.new;
Alternatively, you can specifiy the authentication credentials while initializing the RestClient
.
client = RestClient.new('<auth_id>', '<auth_token>');
The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
client.resources.create(params); # Create
client.resources.get(resource_identifier); # Get
client.resources.update(resource_identifier, params); # Update
client.resources.delete(resource_identifier); # Delete
client.resources.list; # List all resources, max 20 at a time
You can also use the resource
directly to update and delete it. For example,
resource = client.resources.get(resource_identifier);
resource.update(params); # update the resource
resource.delete(); # Delete the resource
Also, using client.resources.list
would list the first 20 resources by default (which is the first page, with limit
as 20, and offset
as 0). To get more, you will have to use limit
and offset
to get the second page of resources.
To list all resources, you can simply use the following pattern that will handle the pagination for you automatically, so you won't have to worry about passing the right limit
and offset
values.
client.resources.each do |resource|
puts resource.id
end
require "plivo"
include Plivo
client = RestClient.new
response = client.messages.create(
src: '+14156667778',
dst: '+14156667777',
text: 'Hello, this is a sample text'
)
require 'rubygems'
require 'plivo'
include Plivo
client = RestClient.new
call_made = client.calls.create(
'+14156667778',
['+14156667777'],
'https://answer.url'
)
require 'rubygems'
require 'plivo'
include Plivo
client = RestClient.new
resp = client.lookup.get('<number-here>')
require 'rubygems'
require 'plivo'
include Plivo::XML
response = Response.new
response.addSpeak('Hello, world!')
puts response.to_xml # Prints the XML string
xml_response = PlivoXML.new(response)
puts xml_response.to_xml # Prints XML along with XML version & encoding details
This generates the following XML:
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<Speak>Hello, world!</Speak>
</Response>
require 'rubygems'
require 'plivo'
include Plivo
client = Phlo.new('<auth_id>', '<auth_token>')
# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
# then initialize client as:
# client = Phlo.new
# run a phlo:
begin
#parameters set in PHLO - params
params = {
from: '+14156667778',
to: '+14156667777'
}
response = phlo.run(params)
puts response
rescue PlivoRESTError => e
puts 'Exception: ' + e.message
end
More examples are available here. Also refer to the guides for configuring the Rails server to run various scenarios & use it to test out your integration in under 5 minutes.
Report any feedback or problems with this version by opening an issue on Github.