Skip to main content
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.
1

Create Your Hany Account

Go to 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.
2

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.
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 for best practices.
3

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.
4

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.
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!"
  }'
A successful request returns an HTTP 200 OK response with a JSON body like this:
Success Response
{
  "status": "success",
  "message_id": "msg_01HXQ9K3R2FZVBTY4PGNWDE87C",
  "to": "+233XXXXXXXXX",
  "from": "YourBrand",
  "segments": 1,
  "cost": 0.02,
  "currency": "GHS",
  "created_at": "2024-11-01T10:32:00Z"
}
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.

​
Next Steps

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

Sender IDs

Learn how to register and manage alphanumeric Sender IDs, check approval status, and set a default Sender ID for your account.

Campaigns

Send bulk SMS to contact lists, schedule campaigns for a future date and time, and track delivery rates in the dashboard.

API Reference

Browse the complete REST API reference — all endpoints, request parameters, response schemas, and error codes.

Authentication

Understand how API key authentication works, how to rotate keys, and how to store secrets securely in your environment.