A nodejs wrapper for nexmo (http://nexmo.com/) API to send SMS
Download and Install lib/nexmo.js in your lib
or
use "npm install easynexmo -g"
var nexmo = require('./lib/nexmo');
nexmo.initialize(KEY,SECRET,API_PROTOCOL,DEBUG);
KEY - API Key from Nexmo
SECRET - API SECRET from Nexmo
API_PROTOCOL - http or https
DEBUG - set this to true to debug library calls
###Send a text message
nexmo.sendTextMessage(sender,recipient,message,opts,callback)
###Send a Binary Message
nexmo.sendBinaryMessage(fromnumber, tonumber,body, udh, callback);
body - Hex encoded binary data udh - Hex encoded udh
###Send a WAP Push Message
nexmo.sendWapPushMessage(fromnumber,tonumber,title,url,validity,callback);
validity is optional if given should be in milliseconds.
###Check Account Balance nexmo.checkBalance(callback);
###Get Pricing for sending message to a country.
nexmo.getPricing(countryCode,callback);
countryCode - 2 letter ISO Country Code
###Get all numbers associated to the account.
nexmo.getNumbers(callback);
###Search for MSISDN's available to purchase.
nexmo.searchNumbers(countryCode,pattern,callback);
pattern is optional, pass numbers to match in the search
###Change Password (API Secret)
nexmo.changePassword(<NEW_PASSWORD>,callback);
###Change Callback URL associated to the account
nexmo.changeMoCallbackUrl(<NEW_CALLBACK_URL>,callback);
###Change Delivery Receipt URL associated to the account
nexmo.changeDrCallbackUrl(<NEW_DR_CALLBACK_URL>,callback);
###Send TTS Message
nexmo.sendTTSMessage = function(<TO_NUMBER>,message,options,callback);
###Send TTS Prompt With Capture
nexmo.sendTTSPromptWithCapture(<TO_NUMBER>,message,<MAX_DIGITS>, <BYE_TEXT>,options,callback);
###Send TTS Prompt With Confirm
nexmo.sendTTSPromptWithConfirm(<TO_NUMBER>, message ,<MAX_DIGITS>,'<PIN_CODE>',<BYE_TEXT>,<FAILED_TEXT>,options,callback);
###Make a voice call
nexmo.call(<TO_NUMBER>,<ANSWER_URL>,options,callback);
Callback from all API calls returns 2 parameters - error and a json object.
An example callback function :
function consolelog (err,messageResponse) {
if (err) {
console.log(err);
} else {
console.dir(messageResponse);
}
}
Refer here http://nexmo.com/documentation/ to get the schema for the returned message response object.
Copyright (c) 2011 Prabhu Velayutham
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.