Skip to content

Getting Started

Installation

npm

npm install mnotify-ts-sdk

JSR

npx jsr add @adjarnor/mnotify-ts-sdk

Deno

deno add @adjarnor/mnotify-ts-sdk

Basic Setup

Create a client with your API key:

ts
import { MNotify } from "mnotify-ts-sdk";

const mnotify = new MNotify({
  apiKey: process.env.MNOTIFY_API_KEY!,
});

Configuration

OptionDefaultDescription
apiKey(required)Your mNotify API key
baseUrlhttps://api.mnotify.com/apiAPI base URL
timeout10000Request timeout in ms
maxRetries3Max retries on rate limits
ts
const mnotify = new MNotify({
  apiKey: "your-api-key",
  timeout: 5000,
  maxRetries: 5,
});

Service Overview

The client exposes five services:

ServiceDescription
mnotify.smsSend SMS and check delivery status
mnotify.contactsManage contacts
mnotify.groupsManage contact groups
mnotify.templatesManage SMS templates
mnotify.accountCheck balance and manage sender IDs

Every method returns a Result type — see Error Handling for details.