Notify Africa SDK

SMS, WhatsApp, Voice, AI Chatbots, and CRM - all in one powerful platform designed for businesses across Africa.

This is a TypeScript/JavaScript SDK for interacting with the Notify Africa API, focusing on SMS messaging features. It provides a simple class-based interface for sending single or batch SMS messages and checking message status. Built with native fetch for zero external dependencies (requires Node.js >= 18.0.0).

Features

• Send single SMS messages
• Send batch SMS messages to multiple recipients
• Check the status of sent messages
• Configurable base URL (defaults to https://api.notify.africa)
• TypeScript support with full type definitions
• No external dependencies

Installation

Install the package via npm:

npm install notify-africa

Or via yarn:

yarn add notify-africa

Usage

Import and Initialize

import { NotifyAfricaSMS } from 'notify-africa';

const apiToken = 'your-api-token-here'; // Replace with your Notify Africa API token
const client = new NotifyAfricaSMS(apiToken); // Uses default base URL: https://api.notify.africa

Send a Single Message

async function sendSingle() {
  try {
    const response = await client.sendSingleMessage(
      '255689737459', // Phone number
      'Hello from Notify Africa SDK!', // Message
      '137' // Sender ID
    );
    console.log('Single message sent:', response); // { messageId: '156023', status: 'PROCESSING' }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

sendSingle();

Send Batch Messages

async function sendBatch() {
  try {
    const response = await client.sendBatchMessages(
      ['255763765548', '255689737839'], // Array of phone numbers
      'Test batch message', // Message
      '137' // Sender ID
    );
    console.log('Batch messages sent:', response); // { messageCount: 2, creditsDeducted: 2, remainingBalance: 1475 }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

sendBatch();

Check Message Status

async function checkStatus() {
  try {
    const response = await client.checkMessageStatus('156022'); // Message ID
    console.log('Message status:', response); // { messageId: '156022', status: 'SENT', sentAt: null, deliveredAt: '2025-11-13T12:34:08.540Z' }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

checkStatus();

API Reference

Constructor

new NotifyAfricaSMS(apiToken: string, baseUrl?: string)

• apiToken: Your Notify Africa API bearer token (required).
• baseUrl: Optional base URL for the API (defaults to 'https://api.notify.africa').

Methods

• sendSingleMessage(phoneNumber: string, message: string, senderId: string): Promise<SendSingleResponse>

  • Sends a single SMS.
  • Returns: { messageId: string, status: string }

• sendBatchMessages(phoneNumbers: string[], message: string, senderId: string): Promise<SendBatchResponse>

  • Sends SMS to multiple recipients.
  • Returns: { messageCount: number, creditsDeducted: number, remainingBalance: number }

• checkMessageStatus(messageId: string): Promise<MessageStatusResponse>

  • Retrieves the status of a message.
  • Returns: { messageId: string, status: string, sentAt: string | null, deliveredAt: string | null }

All methods are asynchronous and throw errors on failure.

Integration with Frameworks

NestJS Example

Create a service:

import { Injectable } from '@nestjs/common';
import { NotifyAfricaSMS } from 'notify-africa';

@Injectable()
export class SmsService {
  private client: NotifyAfricaSMS;

  constructor() {
    this.client = new NotifyAfricaSMS(process.env.NOTIFY_AFRICA_TOKEN);
  }

  async sendSingle(phone: string, message: string, senderId: string) {
    return this.client.sendSingleMessage(phone, message, senderId);
  }

  // Add other methods as needed
}

Requirements

• Node.js >= 18.0.0 (for native fetch support)

Development

• Clone the repo: git clone https://github.com/tacherasasi/notify-africa.git
• Install dependencies: npm install
• Build: npm run build
• Test: npm run test

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

MIT License. See LICENSE for details.

Support

For API-related questions, visit the Notify Africa Developers Portal.

Author: Tachera Sasi [email protected] (https://tachera.ekilie.com)