# SplitSMS

> Bulk SMS, OTP, and wallet API for Ghana, Nigeria, and 190+ countries. Operated by Tecunit.

## Docs for AI / vibe coding

- OpenAPI: https://www.splitsms.com/openapi.json
- API reference: https://www.splitsms.com/api-docs
- Developer portal: https://www.splitsms.com/developers
- Integration generator: https://www.splitsms.com/developers/generate
- AI prompt library: https://www.splitsms.com/developers/prompts
- Vibe coders landing: https://www.splitsms.com/vibe-coders
- SDK install: https://www.splitsms.com/sdk
- Postman: https://www.splitsms.com/developers/postman

## Authentication

All API requests: `Authorization: Bearer YOUR_API_KEY`
Base URL: https://www.splitsms.com/api/v1

Create keys at https://www.splitsms.com/developers/api-keys
Use sandbox keys (sk_test_) for safe development — no live SMS, no credit charges.
OTP sandbox verify code: 123456

## Core endpoints

| Method | Path | Purpose |
|--------|------|---------|
| GET | /balance | Wallet + SMS credits |
| POST | /sms/send | Send SMS |
| POST | /otp/send | Send OTP |
| POST | /otp/verify | Verify OTP |
| GET | /reports | Delivery reports |
| POST | /connect/customers | Provision embedded customer |
| GET | /sender-ids | List sender IDs |

Full spec: https://www.splitsms.com/openapi.json

## JavaScript SDK

Install (NOT from npm registry):
```bash
npm install https://www.splitsms.com/sdk/javascript/splitsms-sdk.tgz
```

```ts
import { SplitSMS } from "@splitsms/sdk";
const client = new SplitSMS({ apiKey: process.env.SPLITSMS_API_KEY!, baseUrl: "https://www.splitsms.com" });
await client.messages.send({ sender: "MYBRAND", recipients: ["233201234567"], message: "Hello" });
```

## WordPress

Official plugin v1.6.3: https://www.splitsms.com/integrations/wordpress
Download: https://www.splitsms.com/wordpress-plugin/splitsms.zip
WooCommerce, WPForms, CF7, Elementor, JetFormBuilder, Crocoblock supported.

## Environment variables

SPLITSMS_API_KEY=sk_test_... or sk_live_...
SPLITSMS_BASE_URL=https://www.splitsms.com

## Support

https://www.splitsms.com/support