@nabcellent/wavesms v3.0.0

WaveSMS Api

This is a Typescript package that interfaces with the WaveSMS Api. The API enables you to initiate mobile SMS notifications.

Documentation

Installation

You can install the package via npm or yarn:

yarn add @nabcellent/wavesms

Getting Started

Initialize the WaveSMS class with your config.

import { WaveSMS, WaveSMSConfig } from '@nabcellent/wavesms';

let config: WaveSMSConfig = {
    apiKey   : process.env.WAVE_SMS_API_KEY,
    partnerId: process.env.WAVE_SMS_PARTNER_ID,
    senderId : process.env.WAVE_SMS_SENDER_ID
};

const wave = new WaveSMS(config);

• SMS

  Enables you to send text messages

1. Send SMS

const response = await wave.sms.text('#WaveSMSTest').to(254123456789).send()
    //  OR
const response = await wave.sms.text('#WaveSMSTest').to([254123456789]).send()

//  Expected responses
[
    {
        "respose-code": 200,
        "response-description": "Success",
        "mobile": "254123456789",
        "messageid": 75085465,
        "clientsmsid": "1234",
        "networkid": "2"
    },
    {
        "response-code": 1004,
        "response-description": "Low credit units to send message, Current balance 0.00, Required 1",
        "mobile": "254123456789",
    }
]

2. Schedule SMS

const response = await wave.sms.text('#WaveSMSTest').to(254123456789).send(new Date('2023-12-20'))

3. Get Delivery Report

//  Provide Message ID
const response = await wave.sms.getDeliveryReport("123456789")

//  Expected response
{
    "response-code": 200,
    "message-id": "123456789",
    "response-description": "Success",
    "delivery-status": 32,
    "delivery-description": "DeliveredToTerminal",
    "delivery-tat": "00:00:06",
    "delivery-networkid": 1,
    "delivery-time": "2023-02-18 21:16:22"
}

• Account

  Enables you to check the balance of your account

1. Account balance

const response = await wave.balance.fetch()

//  Expected response(number)
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

• Nabcellent

comment: <> (- All Contributors(../../contributors))

License

The MIT License (MIT). Please see License File for more information.