geezsms v1.0.2

GeezSMS Node.js Library

The GeezSMS Node.js library offers a convenient way to integrate SMS functionalities into applications written in server-side JavaScript, focusing on sending SMS messages.

Documentation

For additional details, visit the Developer API docs.

Requirements

Node.js version 8, 10, or higher.

Installation

Install the GeezSMS package using npm or Yarn:

npm install geezsms --save
# or
yarn add geezsms

Usage

To use the library, you need to configure it with your account's API key, which you can obtain from the GeezSMS Dashboard.

Using CommonJS

const GeezSMS = require('geezsms').default;
const geezSMS = new GeezSMS('YOUR_API_KEY');

Using ES Modules

import GeezSMS from 'geezsms';
const geezSMS = new GeezSMS('YOUR_API_KEY');

Sending an SMS

To send an SMS, use the single property of the GeezSMS instance:

const message = {
  phone: 'recipient_phone_number',
  msg: 'Your message text',
  sender_id: 'your_sender_id',  // Optional
  callback: 'your_callback_url',  // Optional
};

try {
  const response = await geezSMS.single.send(message);
  console.log('Message sent successfully:', response);
} catch (error) {
  console.error('Failed to send message:', error);
}

Advanced SMS Options

You can specify additional options such as using a template or sandbox mode:

const message = {
  phone: 'recipient_phone_number',
  msg: 'Your message text',
  template: true,
  templateValues: {
    name: 'John',
    date: '2022-06-15',
  },
};

const options = {
  sandbox: true,
  apiVersion: 1,
};

try {
  const response = await geezSMS.single.send(message, options);
  console.log('Message sent successfully:', response);
} catch (error) {
  console.error('Failed to send message:', error);
}

Handling Errors

The library provides detailed exceptions for various errors such as unauthorized access, bad requests, and network issues:

Change Log

• Version 1.0.0 (June 14, 2024): Initial release supporting basic SMS functionalities.
• Version 1.0.0 (June 14, 2024): Added support for SMS templates and advanced error handling.

More Information

• REST API Version
• GeezSMS