Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A Ruby wrapper for the Nexmo API
Ruby
branch: master

README.md

nexmo

A Ruby wrapper for the Nexmo API.

Installation

$ gem install nexmo

Sending a message

Construct a Nexmo::Client object with your API credentials and call the #send_message method to send a message. For example:

require 'nexmo'

nexmo = Nexmo::Client.new(key: 'YOUR API KEY', secret: 'YOUR API SECRET')

nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')

This method call returns the message id and other details if the message was sent successfully, or raises an exception if there was an error.

The Nexmo documentation contains a list of error codes which may be useful for debugging exceptions. Remember that phone numbers should be specified in international format, and other country specific restrictions may apply (e.g. US messages must originate from either a pre-approved long number or short code).

Production environment variables

Best practice for storing credentials for external services in production is to use environment variables, as described by 12factor.net/config. Nexmo::Client defaults to extracting the api key/secret it needs from the NEXMO_API_KEY and NEXMO_API_SECRET environment variables if the key/secret options were not specified explicitly.

Something went wrong with that request. Please try again.