SMS API Home Delivery Node JS Addon

Introduction to the SMS API Home Delivery Node.js Addon Tutorial

The SMS API Home Delivery Node.js Addon is a powerful tool that enables you to send SMS messages programmatically using Node.js. With this tutorial, you will learn how to use the SMS API to send SMS messages to recipients, handle responses, and track the delivery status of your messages.

The SMS API Home Delivery Node.js Addon provides a wide range of features, including:

• Sending SMS messages to individuals or groups
• Handling responses from recipients
• Tracking the delivery status of messages
• Supporting multiple SMS operators

In this tutorial, you will learn how to integrate the SMS API with your Node.js application using the Home Delivery Node.js Addon. You will create a simple application that sends an SMS message to a recipient and tracks its delivery status.

Getting Started with the SMS API Home Delivery Node.js Addon

To get started, you need to have a few things:

1. Node.js installed on your computer: Make sure you have Node.js installed on your computer. If you don't have Node.js installed, you can download it from the official Node.js website.
2. SMS API Account: You need an account with the SMS API to use the Home Delivery Node.js Addon. Create an account on the SMS API website and note your API key and sender ID.
3. Install the Home Delivery Node.js Addon: Open a terminal or command prompt on your computer and type the following command to install the Home Delivery Node.js Addon:

   npm install smshomedelivery

4. Import the Home Delivery Node.js Addon in your Node.js Application: Create a new Node.js file (e.g. sms.js) and add the following code:

   const Homedelivery = require('smshomedelivery');
   const hd = new Homedelivery('YOUR_API_KEY', 'YOUR_SENDER_ID');

   Replace YOUR_API_KEY and YOUR_SENDER_ID with your actual API key and sender ID.

Sending an SMS Message

To send an SMS message using the SMS API Home Delivery Node.js Addon, you can use the sendMessage() method. Here is an example:

const recipientNumber = '+1234567890';
const message = 'Hello World!';

hd.sendMessage(recipientNumber, message).then((response) => {
  console.log('Message sent successfully:', response);
}).catch((error) => {
  console.error('Error sending message:', error);
});

In this example, we are sending an SMS message to the recipient phone number +1234567890 with the message Hello World!. The sendMessage() method returns a promise that resolves with the response from the SMS API or rejects with an error if an error occurs.

Tracking the Delivery Status

You can track the delivery status of your SMS messages by using the getStatus() method. Here is an example:

const messageId = response.getMessageId();

hd.getStatus(messageId).then((status) => {
  console.log('Message delivery status:', status);
}).catch((error) => {
  console.error('Error getting message status:', error);
});

In this example, we are tracking the delivery status of the SMS message by retrieving the message ID from the response and then calling the getStatus() method.

Handling Responses

The SMS API Home Delivery Node.js Addon allows you to handle responses from recipients by using the registerResponseHandler() method. Here is an example:

hd.registerResponseHandler((response) => {
  console.log('Received response:', response);
});

In this example, we are registering a response handler function that will be called when the SMS API receives a response from a recipient.

That's it! This concludes the tutorial on using the SMS API Home Delivery Node.js Addon to send SMS messages, track their delivery status, and handle responses. With this Addon, you can now integrate SMS messaging into your Node.js application.

Full Code:

const Homedelivery = require('smshomedelivery');
const hd = new Homedelivery('YOUR_API_KEY', 'YOUR_SENDER_ID');

const recipientNumber = '+1234567890';
const message = 'Hello World!';

hd.sendMessage(recipientNumber, message).then((response) => {
  console.log('Message sent successfully:', response);
  const message_id = response.getMessageId();

  hd.getStatus(messageId).then((status) => {
    console.log('Message delivery status:', status);
  });

}).catch((error) => {
  console.error('Error sending message:', error);
});

hd.registerResponseHandler((response) => {
  console.log('Received response:', response);
});

Remember to replace YOUR_API_KEY and YOUR_SENDER_ID with your actual API key and sender ID.