The TeleSign Ruby SDK lets you easily integrate with our REST API.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
test
.gitignore
.travis.yml
LICENSE
README.rst
RELEASE
Rakefile
ruby_banner.jpg
ruby_banner_enterprise.jpg
telesign.gemspec

README.rst

https://raw.github.com/TeleSign/ruby_telesign/master/ruby_banner.jpg

TeleSign Ruby SDK

TeleSign is a communications platform as a service (CPaaS) company, founded on security. Since 2005, TeleSign has been a trusted partner to the world’s leading websites and mobile applications, helping secure billions of end-user accounts. Today, TeleSign’s data-driven, cloud communications platform is changing the way businesses engage with customers and prevent fraud.

For more information about TeleSign, visit our website.

Documentation

Code documentation is included in the SDK. Complete documentation, quick start guides and reference material for the TeleSign API is available within the TeleSign Standard Documentation.

Installation

To install the TeleSign Ruby SDK:

$ gem install telesign

Ruby 2+ is required for the TeleSign Ruby SDK.

Authentication

You will need a Customer ID and API Key in order to use TeleSign’s API. If you already have an account you can retrieve them from your account dashboard within the Portal. If you have not signed up yet, sign up here.

Dependencies

We make use of popular, feature-rich and well-tested open-source libraries to perform the underlying functionality of the SDK. These dependencies are managed by the community accepted package manager. If you are unable to add these additional third party dependencies to your project we have ensured that the SDK code is easy to read and can serve as sample code. We have also made sure that more complicated functions such as generate_telesign_headers can be easily extracted from the SDK and used 'as is' in your project.

Ruby Code Example: Messaging

Here is a basic code example with JSON response.

require 'telesign'

customer_id = 'FFFFFFFF-EEEE-DDDD-1234-AB1234567890'
api_key = 'EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=='

phone_number = 'phone_number'
message = 'You\'re scheduled for a dentist appointment at 2:30PM.'
message_type = 'ARN'

messaging_client = Telesign::MessagingClient.new(customer_id, api_key)
response = messaging_client.message(phone_number, message, message_type)
{'reference_id': 'DGFDF6E11AB86303ASDFD425BE00000657',
 'status': {'code': 103,
    'description': 'Call in progress',
    'updated_on': '2016-12-12T00:39:58.325559Z'}}

For more examples, see the examples folder or visit the TeleSign Standard Documentation.