Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Ruby wrapper for the Nexmo API
Ruby
Tag: v0.3.0

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
README.md
Rakefile
nexmo.gemspec

README.md

A simple wrapper for the Nexmo API

Installation

Run gem install nexmo and require 'nexmo', or do the gemfile/bundle thing if you're using Rails.

Usage

Construct a client object with your Nexmo API credentials:

nexmo = Nexmo::Client.new('...KEY...', '...SECRET...')

The underlying HTTP object is easily accessible. For example, you may want to adjust the SSL verification when testing locally:

nexmo.http.verify_mode = OpenSSL::SSL::VERIFY_NONE

Use the send_message method to send an SMS, passing the API parameters as a hash:

response = nexmo.send_message({
  from: 'RUBY',
  to: '...NUMBER...',
  text: 'Hello world'
})

Phone numbers should be specified in international format. If the response is successful you can access the message id, and if it's a failure you can retrieve the error message and/or the underlying HTTP response returned from the server:

if response.success?
  # store response.message_id
elsif response.failure?
  # check response.error.message and/or response.http
  # raise response.error
end

The Nexmo documentation contains a list of error codes which may be useful if you have problems sending a message.

That's all folks. Chunky bacon.

Something went wrong with that request. Please try again.