Freemobile-api NPM

FreeMobile Plugin

FreeMobile Plugin is a Node.js module to simplify interaction with the FreeMobile API for sending SMS messages.

Installation

Install the module using npm:

npm install freemobile-api@latest

Usage

DISCLAMER : You need a subscription to Free Mobile to use this API.

const FreeMobile = require('freemobile-api');

// Replace 'YOUR_USER' and 'YOUR_PASS' with your FreeMobile credentials
const credentials = { user: 'YOUR_USER', pass: 'YOUR_PASS' };
const freeMobile = new FreeMobile(credentials);

// Send an SMS (Your message can't exceed the default SMS limit of 160 character.)
freeMobile.send('Hello World!')
  .then(response => console.log('SMS sent:', response))
  .catch(error => console.error('Error:', error.message));

Explanations

The FreeMobile Node.js Plugin provides a simple API with the following methods:

`new FreeMobile(credentials)`

Creates a new instance of the FreeMobile class with the specified credentials.

Parameters:
- credentials (Object): An object containing the following properties:
  - user (String): Your FreeMobile account username.
  - pass (String): Your FreeMobile API key.

`FreeMobile.send(message)`

Sends an SMS message through the FreeMobile API.

Parameters:
- message (String): The text of the SMS message to be sent.
Returns:
- A Promise that resolves with the API response.

Module features

1 - Send large messages.

The API has a limit of 999 characters. If your message is longer, the plugin breaks it into chunks, each no longer than 999 characters. This helps ensure successful message delivery through the API without exceeding its limits.

If you want more features, see contributions

API codes

API codes are not more than HTTP codes.

200 : Success - SMS sent
400 : One or multiple parameters are missing or incorrect
402 : Too many request. Try again later
403 : Acces denied, make sure the option is enabled on your FreeMobile account or check your credentials.
500 : Server internal error. Try again later.