fitsms
v2.0.1
Published
The official-style Node.js SDK for the FitSMS.lk gateway.
Downloads
367
Maintainers
Readme
FitSMS Node.js SDK
A high-performance, Promise-based Node.js wrapper for the FitSMS.lk API. This SDK provides a clean interface for sending SMS, checking delivery status, and managing account balances.
🚀 Features
- Bearer Token Auth: Secure authentication via headers.
- Flexible Recipients: Supports strings, comma-separated lists, and arrays.
- Real-time Status: Retrieve delivery reports using message UIDs.
- Balance Monitoring: Track remaining SMS units.
- Lightweight: Minimal dependencies.
📦 Installation
npm install fitsms🛠 Usage
Initialization
const FitSMS = require("fitsms");
const sms = new FitSMS("YOUR_BEARER_TOKEN", "The Change");Sending SMS
async function sendAlert() {
try {
const recipients = ["94XXXXXXXXX", "94XXXXXXXX"];
const response = await sms.send(
recipients,
"This is a test message from FitSMS SDK",
);
console.log("Success:", response.data.uid);
} catch (error) {
console.error("Error:", error.message);
}
}Checking Message Status
const status = await sms.getStatus("606812e63f78b", "9476XXXXXXXX");
console.log("Delivery Status:", status.data.status);Checking Balance
const balance = await sms.getBalance();
console.log("Remaining Units:", balance.data);📖 API Reference
| Method | Parameters | Description | | ------------ | ------------------------- | ------------------- | | send() | recipients, message, type | Sends an SMS | | getStatus() | ruid, recipient | Get delivery status | | getBalance() | none | Get SMS balance | | getProfile() | none | Get account profile |
📄 License
This project is licensed under the MIT License.
🤝 Contributing
Contributions, issues, and feature requests are welcome!
👨💻 Maintainer
Maintained by Global Cloud Media (pvt) Ltd.
