https://github.com/honorablecon/orangesms-api

This gem aims to let you quickly send SMS from JavaScript and Python using the Orange SMS API.
https://github.com/honorablecon/orangesms-api

Last synced: 2 months ago
JSON representation

This gem aims to let you quickly send SMS from JavaScript and Python using the Orange SMS API.

• Host: GitHub
• URL: https://github.com/honorablecon/orangesms-api
• Owner: honorableCon
• License: mit
• Created: 2022-01-04T00:06:27.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-08T17:01:41.000Z (almost 3 years ago)
• Last Synced: 2024-10-15T15:19:37.585Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 17.6 KB
• Stars: 11
• Watchers: 1
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Orange SMS API 📬

[![Made-In-Senegal](https://github.com/GalsenDev221/made.in.senegal/blob/master/assets/badge.svg)](https://github.com/GalsenDev221/made.in.senegal)

> Orange SMS is a client library that allow you to send SMS with Javascript and Python using the [Orange SMS API](https://developer.orange.com/apis/sms-sn/overview)

## Disclaimer ⛔

This gem is not an official client of Orange, in order to use the client you need to create a [Orange SMS API](https://developer.orange.com/apis/sms-sn/overview) and to register an app in the developer dashboard that orange provide to you.  

After registering your app you can ask for SMS integration approval (this process can take time :)  

The registration process is detailed [here](https://developer.orange.com/apis/sms-sn/overview)

Instead of reading and trying to understand once again how the Orange SMS API work this gem aims to let you quickly send SMS from JavaScript and Python using the [Orange SMS API](https://developer.orange.com/apis/sms-sn/overview).

Check this [link](https://developer.orange.com/apis/sms-sn/overview) to find the steps of app creation.

## Install 📥

### Via NPM

`npm i orange-sms-client`

## Usage ✅

1. Copy your client id [here](https://developer.orange.com/myapps)

(if you have already create an app)

2. generate token with `getToken` function

3. send sms with `sendSMS` function

Exemple : [usageExample.py](/python/usageExample.py) | [usageExample.js](/javascript/usageExample.js)

### JavaScript 💛

```javascript

const clientID = "your clientID"

const token = await getToken(clientID)

let senderAdress = "+2210000"

let address = "+221{{receiver}}"

sendSMS(senderAdress, address, 'message', token)

```

### Python 🐍

```python

clientID="your clientID"

token = getToken(clientID)

senderAdress = "+2210000"

address = "+221{{receiver}}"

sendSMS(senderAddress, receiverAddress, "message", token)

```

### Modules 

- **sendSMS** : for sending SMS

  - params : 

      - senderAddress

      - receiverAddress

      - message

      - token

  - return

      - response

 

 - **getToken** : to get token

    - params :

        - token

     - return :

        - token

 - **showBalanceSMS** : to show balance

    - params :

        - token

     - return :

        - balance

 - **getUsageStats** : to get usage stats

    - params :

        - token

     - return :

        - stats

#### Contributing 🤝

Bug reports and Pull Requests are welcome 👋🏽  

You can tell me **[HERE](https://github.com/honorableCon/OrangeSMS-API/issues)**

#### License 🔖

This project is under **[MIT License](https://opensource.org/licenses/MIT)**.