WebSMS Api
This is a Typescript package that interfaces with the WebSMS Api.
The API enables you to initiate mobile SMS notifications.
Check out their api documentation.
Documentation
Installation
You can install the package via npm or yarn:
yarn add @nabcellent/websms
Getting Started
Initialize the WebSMS class with your config.
import { WebSMS, WebSMSConfig } from '@nabcellent/websms';
let config: WebSMSConfig = {
accessKey: process.env.WEBSMS_ACCESS_KEY,
apiKey : process.env.WEBSMS_API_KEY,
clientId : process.env.WEBSMS_CLIENT_ID,
senderId : process.env.WEBSMS_SENDER_ID
};
const web = new WebSMS(config);
Enables you to send text messages
1. Send SMS
const response = await web.sms.text('#WebSMSTest').to(254123456789).send()
const response = await web.sms.text('#WebSMSTest').to([254123456789]).send()
{
code: 0,
description: null,
data: [
{
message_id: "7444f504-6760-43fd-9b40-2708da61d114",
code: 0,
description: "Success",
phone: "254123456789",
custom: ""
},
{
message_id: "",
code: 801,
description: "Country not found in master data",
phone: "89254736388405",
custom: ""
}
]
}
2. Schedule SMS
Provide a Moment or Date instance to the send method.
const response = await web.sms.text('#WebSMSTest').to([254123456789]).send(moment().add(1, 'm'))
PS: The date must be after current time.🌚
3. Calculate SMS Cost
Provide the text message.
const response = web.sms.cost('Hello World.')
0.3
Enables you to check the balance of your account
- Account balance
const response = await web.balance.fetch()
7.33
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email nabcellent.dev@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.