@quartix/sms

The official Node.js SDK for the Quartix SMS Gateway. Send SMS messages programmatically through your own Android devices.

Installation

npm install @quartix/sms

Quick Start (ID-only Auth)

import { QuartixSms } from '@quartix/sms';

// Use your Gateway ID as the API Key for simplified setup
const sms = new QuartixSms({
  apiKey: 'YOUR_GATEWAY_ID', 
  baseUrl: 'https://api.quartix.in' // Optional
});

async function main() {
  try {
    const result = await sms.send({
      to: '+919876543210',
      message: 'Hello from Quartix SDK!'
    });
    
    console.log('Message sent! ID:', result.messageId);
  } catch (error) {
    console.error('Failed to send SMS:', error.message);
  }
}

main();

Batch Sending

Send multiple messages in a single API call for maximum efficiency.

const batchResult = await sms.sendBatch({
  messages: [
    { to: '+919000000001', message: 'Alert 1' },
    { to: '+919000000002', message: 'Alert 2' },
  ]
});

console.log(`Successfully queued ${batchResult.totalSent} messages.`);

Features

• Simplified Auth: Use your Gateway ID directly as the token.
• Send SMS: Queue messages to be sent by your connected Android devices.
• Batch Operations: Send messages to multiple recipients in one go.
• Message Status: Track if your message is PENDING, SENT, or DELIVERED.
• TypeScript Support: Full type safety out of the box.

API Reference

new QuartixSms(options)

• apiKey: Your Gateway ID or Account API Key.
• baseUrl: The API endpoint (defaults to production).
• timeout: Request timeout in ms (default: 30000).

sms.send(options)

• to: Recipient phone number.
• message: Text content.
• simIndex: (Optional) Use specific SIM slot (0 or 1).
• gatewayId: (Optional) Override targeted gateway.

sms.sendBatch(options)

• messages: Array of message objects (to, message, simIndex).
• gatewayId: (Optional) Global gateway override for the batch.

sms.getMessageStatus(id)

• Returns the current status of a message.

License

MIT