CloudSMS Node.js SDK

A Node.js SDK for the CloudSMS API, allowing you to easily integrate SMS functionality into your Node.js applications.

Installation

You can install the package using npm:

npm install cloudsms

Or using yarn:

yarn add cloudsms

Requirements

• Node.js 12 or higher

Quick Start

import { CloudSMSClient } from 'cloudsms';

// Initialize the client
const client = new CloudSMSClient(
    'your-api-token',
    'your-sender-id'
);

// Example: Get your balance
async function checkBalance() {
    const response = await client.getBalance();
    if (response.status === 'success') {
        console.log(`Current balance: ${response.data}`);
    }
}

// Example: Send an SMS
async function sendMessage() {
    const response = await client.sendSMS({
        recipient: '+1234567890',
        message: 'Hello from CloudSMS!'
    });
    
    if (response.status === 'success') {
        console.log('SMS sent successfully!');
    } else {
        console.error(`Error: ${response.message}`);
    }
}

API Reference

CloudSMSClient

The main class for interacting with the CloudSMS API.

Constructor

const client = new CloudSMSClient(apiToken: string, senderId: string);

• apiToken: Your CloudSMS API token
• senderId: Your CloudSMS sender ID

Methods

getBalance()

Get your current account balance.

const response = await client.getBalance();

Returns:

{
    status: 'success',
    data: '100.00'  // Balance amount without currency symbol
}

sendSMS(params)

Send an SMS message to one or multiple recipients.

const response = await client.sendSMS({
    recipient: '+1234567890', // or ['number1', 'number2']
    message: 'Hello from CloudSMS!',
    scheduleTime?: new Date(), // optional
    dltTemplateId?: 'template-id' // optional
});

sendCampaign(params)

Send an SMS campaign to one or multiple contact lists.

const response = await client.sendCampaign({
    contactListIds: 'list-id', // or ['list1', 'list2']
    message: 'Campaign message',
    scheduleTime?: new Date(), // optional
    dltTemplateId?: 'template-id' // optional
});

getSMS(uid)

Get details of a specific SMS.

const response = await client.getSMS('sms-uid');

listSMS()

Get a list of all SMS messages.

const response = await client.listSMS();

getCampaign(uid)

Get details of a specific campaign.

const response = await client.getCampaign('campaign-uid');

Error Handling

All methods return a response object with at least a "status" field that can be either "success" or "error". When an error occurs, the response will include an error message:

{
    status: 'error',
    message: 'Error description here'
}

Support

For support, please visit https://cloudsms.gr or contact [email protected].

License

This project is licensed under the MIT License.