albanfk / orange-sms

Node package for sending Sms with Orange Sms Api

Orange-sms

NodeJs library for sending Sms with Orange Sms Api(require NodeJs 7.0.0 and newer)

Context

Those who have already tried to use Orange Africa's SMS sending API have noticed that the documentation on the internet is almost non-existent for both php and Nodejs, and the one on the orange developper website is quite complicated. This library aims to make the API for sending orange text messages accessible to everyone. with it's abstraction Orange-sms makes it possible for all developers to send sms on NodeJs server.

Dependencies

if you have not already installed request node module do it like this npm install request or add this line "request": "^2.85.0" on your package.json file.

Create an Account and App on Orange developper Portal

1. Go to the Orange Developper Portal and create your account
2. Click on my App and create your Orange App
3. Click on Add an Api button and after that select SMS for your country(Ex: SMS Cameroon(All operators)(1.1))
4. Click on configure Api button and buy one SMS pack
5. When it's done click on show button and get the value of Authorization header field, we need to use that later

Install the Orange-sms library

• Get the Orange-sms folder(by clone or download) and put it on the server folder(you have to put all the files inside one folder, ideally the vendors folder)

How it's works

Somewhere inside your code you have to write this:

const options = {
  authorization_header:"Put your Authorization header here", // String; Must be in this form Basic xxxxxxxxxxxxxxxx take it on your Orange Application
  area_code:"+xxx", // String; Telephony code of your country Ex: +237
  sender_number: xxxxxxxxxx, // Number; The number to which you are sending a message without area code
  sender_phone: xxxxxxxxx, // Number; Your number without the area code, this number must be the same that you entered for your registration on Orange website
  sms_body: "Hello what's up?" // String; Your message text to send, not much than 160 characters otherwise Orange will cut it
};
const orangeSms = require('./orangeSms.js') // The path inside require() depends on how your app folder structure is;
      orangeSms(options)
      .then((responseOrangeSms)=>{
        console.log(responseOrangeSms); 
        /* Should output an object like {message:sms sent},{message:401} (401 is an exemple status code of an error if you want the complete list check https://fr.wikipedia.org/wiki/Liste_des_codes_HTTP),
           {message:You have to provide all the keys of the object},{message:the object key must not have a value like null or undefined}
           {message:One or more object keys are incorrectly written}, {message: The parameter must be an object}
           You can interpret the message and continue to write your code 
        */
      }).catch((error)=>{
        console.log(error);
      });

You can use Async/Await if you want, it's on your discretion.

Further documentation

(https://developer.orange.com/apis/sms/getting-started)

Author

Nguetseng Stephane Tel: [phone]