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

# Hany Quickstart — Send Your First SMS in Five Minutes

> Learn how to send your first SMS message with Hany in under 5 minutes. Create an account, get your API key, and make your first API call.

This guide walks you through everything you need to send your first SMS message with Hany. By the end, you'll have a working API call, a registered Sender ID, and a clear path to building more advanced communication workflows.

<Steps>
  <Step title="Create Your Hany Account">
    Go to [hany.tools](https://hany.tools) and click **Get Started** to create your account. During the early access period, you can join the waitlist and reserve your Sender ID to secure your brand name ahead of the full launch.

    Once your account is approved, log in to the Hany dashboard to complete your profile and add your billing details.
  </Step>

  <Step title="Get Your API Key">
    In the Hany dashboard, navigate to **Settings → API Keys** and click **Generate New Key**. Give your key a descriptive name (for example, `production-backend` or `staging-test`) so you can identify it later.

    Copy the key immediately — for security reasons, Hany only displays the full key once. Store it in a password manager or as an environment variable in your application.

    <Warning>
      Never paste your API key directly into source code or commit it to a version control repository. Use environment variables or a secrets manager instead. See the [Authentication guide](/authentication) for best practices.
    </Warning>
  </Step>

  <Step title="Reserve or Register a Sender ID">
    A Sender ID is the name or number your recipients see as the message sender (for example, `YourBrand` or `+233XXXXXXXXX`). In Ghana, alphanumeric Sender IDs must be registered with your mobile network operators before messages are delivered.

    In the dashboard, go to **Sender IDs → Register New** and submit your preferred name along with the required business documentation. Approval typically takes one to three business days. You can use a numeric Sender ID immediately for testing while you wait.
  </Step>

  <Step title="Send Your First SMS">
    With your API key and Sender ID ready, make a `POST` request to the `/v1/sms/send` endpoint. Replace `YOUR_API_KEY`, `YourBrand`, and the recipient number with your actual values.

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X POST https://api.hany.tools/v1/sms/send \
        -H "Authorization: Bearer YOUR_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "to": "+233XXXXXXXXX",
          "from": "YourBrand",
          "message": "Hello from Hany!"
        }'
      ```

      ```javascript JavaScript theme={null}
      const response = await fetch("https://api.hany.tools/v1/sms/send", {
        method: "POST",
        headers: {
          "Authorization": `Bearer ${process.env.HANY_API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify({
          to: "+233XXXXXXXXX",
          from: "YourBrand",
          message: "Hello from Hany!",
        }),
      });

      const data = await response.json();
      console.log(data);
      ```

      ```python Python theme={null}
      import os
      import requests

      response = requests.post(
          "https://api.hany.tools/v1/sms/send",
          headers={
              "Authorization": f"Bearer {os.environ['HANY_API_KEY']}",
              "Content-Type": "application/json",
          },
          json={
              "to": "+233XXXXXXXXX",
              "from": "YourBrand",
              "message": "Hello from Hany!",
          },
      )

      print(response.json())
      ```
    </CodeGroup>

    A successful request returns an HTTP `200 OK` response with a JSON body like this:

    ```json Success Response theme={null}
    {
      "status": "success",
      "message_id": "msg_01HXQ9K3R2FZVBTY4PGNWDE87C",
      "to": "+233XXXXXXXXX",
      "from": "YourBrand",
      "segments": 1,
      "cost": 0.02,
      "currency": "GHS",
      "created_at": "2024-11-01T10:32:00Z"
    }
    ```

    <Tip>
      Hany provides a **sandbox environment** for testing your integration without consuming credits or sending real messages. Set the base URL to `https://sandbox.api.hany.tools/v1` and use any API key generated in your sandbox dashboard. Sandbox responses mirror production responses exactly, making it safe to test error handling and edge cases.
    </Tip>
  </Step>
</Steps>

## Next Steps

You've sent your first message — here's where to go from here:

<CardGroup cols={2}>
  <Card title="Sender IDs" icon="id-card" href="/sms/sender-ids">
    Learn how to register and manage alphanumeric Sender IDs, check approval status, and set a default Sender ID for your account.
  </Card>

  <Card title="Campaigns" icon="bullhorn" href="/sms/campaigns">
    Send bulk SMS to contact lists, schedule campaigns for a future date and time, and track delivery rates in the dashboard.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse the complete REST API reference — all endpoints, request parameters, response schemas, and error codes.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    Understand how API key authentication works, how to rotate keys, and how to store secrets securely in your environment.
  </Card>
</CardGroup>