> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# SMS Alert plugin

> Send SMS messages and manage SMS Alert contacts, templates, delivery reports, and account resources.

Use **SMS Alert** through Corsair: one client, typed API calls.

SMS Alert's [API reference](https://kb.smsalert.co.in/developers-api/) documents API key authentication via the `apikey` query parameter for most operations. Account registration and password reset do not require an API key. Password changes use a form body. Avoid logging request URLs.

With Hub connection reporting enabled, Corsair core currently reports any successful endpoint as credential-verified, including registration and password reset. Those two operations do not check the API key; do not treat their success as API-key verification.

`otp.validate` throws an error with the message `SMS Alert OTP code does not match` for the documented `Code does not match.` response, even though SMS Alert labels it successful. Catch that error to handle a rejected code. For other responses, inspect `description.desc` rather than assuming `status: "success"` means the code matched; the provider has not documented all possible validation outcomes.

Use `messages.send` with `schedule` for scheduled messages, or `dlrurl` and `reference` to request delivery callbacks. Corsair does not provide an inbound webhook handler for those callbacks; secure them in your own application. XML contact import and XML push are excluded because their credential or payload contracts are incomplete. Requests are not automatically retried.

**What you get:**

* 29 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/smsalert better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/smsalert better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/smsalert better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/smsalert better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { smsalert } from '@corsair-dev/smsalert';

export const corsair = createCorsair({
	plugins: [
		smsalert(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the SMS Alert API key before the first call: `pnpm corsair setup --plugin=smsalert --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> smsalert()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'smsalert',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`account.balance`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.smsalert.api.account.balance({});
```

**`account.changePassword`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.smsalert.api.account.changePassword({ pwd: 'old-password', newpwd: 'new-password', cnfpwd: 'new-password' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/smsalert/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/smsalert/api.md)
>
> Every `smsalert.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.