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

# Introduction

> Powerful SMS API for sending messages, managing campaigns, and tracking delivery reports

## Welcome to Ruach (Formerly Netvox) SMS API

The Ruach SMS API provides a comprehensive solution for sending SMS messages, managing campaigns, and tracking delivery reports. Our RESTful API is designed to be simple, reliable, and scalable for businesses of all sizes.

<Card title="Get Started" icon="rocket" href="/api-reference/authentication" horizontal>
  Learn how to authenticate and make your first API call.
</Card>

## Key Features

<Columns cols={2}>
  <Card title="Send SMS Messages" icon="message" href="/api-reference/sms/send-sms-post">
    Send individual or bulk SMS messages with delivery tracking.
  </Card>

  <Card title="Campaign Management" icon="chart-line" href="/api-reference/campaigns/get-campaigns">
    Create and manage SMS campaigns with detailed statistics.
  </Card>

  <Card title="Group Management" icon="users" href="/api-reference/groups/get-groups">
    Organize contacts into groups for targeted messaging.
  </Card>

  <Card title="Template System" icon="file-text" href="/api-reference/templates/get-templates">
    Create and manage message templates for consistent branding.
  </Card>
</Columns>

<Card title="SMTP email" icon="envelope" href="/smtp" horizontal>
  Ruach Email Delivery overview, then outgoing mail setup for apps and desktop clients.
</Card>

## Quick Start

### 1. Authentication

All API requests require authentication using your `ApiKey` and `ClientId`:

```bash theme={null}
curl -X GET "https://accounts.netvox.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID"
```

### 2. Send Your First SMS

```bash theme={null}
curl -X POST "https://accounts.netvox.ng/api/v2/SendSMS" \
  -H "Content-Type: application/json" \
  -d '{
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID",
    "SenderId": "YOUR_SENDER_ID",
    "Message": "Hello from Ruach SMS API!",
    "MobileNumbers": "1234567890"
  }'
```

### 3. Check Delivery Status

```bash theme={null}
curl -X GET "https://accounts.netvox.ng/api/v2/MessageStatus?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID&MessageId=MESSAGE_ID"
```

## API Endpoints

<Columns cols={2}>
  <Card title="Credit Balance" icon="wallet" href="/api-reference/credit-balance">
    Check your account balance and credit status.
  </Card>

  <Card title="Sender ID Management" icon="id-card" href="/api-reference/sender-ids/get-sender-ids">
    Manage your approved sender IDs for SMS delivery.
  </Card>

  <Card title="Delivery Reports" icon="chart-bar" href="/api-reference/webhooks/delivery-reports">
    Set up webhooks to receive real-time delivery reports.
  </Card>

  <Card title="Error Handling" icon="exclamation-triangle" href="/api-reference/error-codes">
    Understand error codes and how to handle API responses.
  </Card>
</Columns>

## Need Help?

<Card title="Contact Support" icon="headset" href="mailto:support@ruach.ng">
  Get help from our technical support team.
</Card>
