Skip to main content
The Hany REST API gives you programmatic access to Hany’s business communication platform. You can send single or bulk SMS messages, manage your Sender IDs, pull delivery reports, and build end-to-end communication workflows — all over standard HTTPS using JSON. Whether you’re building a transactional notification system or a large-scale marketing campaign, the API is designed to be predictable, well-structured, and easy to integrate.

​
Base URL

All API requests are made to the following base URL: 
https://api.hany.tools/v1
Every endpoint path in this reference is appended to this base URL. For example, to send an SMS you call POST https://api.hany.tools/v1/sms/send.

​
Request Format

  • Set the Content-Type header to application/json on all requests that include a body.
  • Send request bodies as raw JSON.
  • All responses are returned as JSON, including errors.
# Example request shape
curl -X POST https://api.hany.tools/v1/sms/send \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{ "to": "+233XXXXXXXXX", "from": "YourBrand", "message": "Hello!" }'

​
Authentication

Every request to the Hany API must include a valid API key as a Bearer token in the Authorization header. You can generate your key from the Hany dashboard. See the Authentication page for full details on obtaining your key, using it in requests, and security best practices.

​
Rate Limits

API rate limits are enforced to ensure fair usage and platform stability. If your integration requires a higher throughput, reach out to support@hany.tools to discuss a plan that fits your volume needs.
When you exceed the rate limit, the API returns a 429 Too Many Requests response. Implement exponential backoff in your retry logic to handle these gracefully. See the Errors page for more detail.

​
Versioning

The API version is embedded in the URL path (e.g., /v1). This ensures that breaking changes never affect your existing integration without warning. When a new version is released, the previous version will continue to be supported for a defined sunset period. You will receive advance notice of any deprecation timeline so you have ample time to migrate.

​
Available Endpoints

The following endpoints are currently live and available to all Hany accounts:
EndpointDescription
POST /sms/sendSend a single SMS to one recipient
POST /sms/bulkSend a bulk SMS campaign to multiple recipients
GET /sms/sender-idsList all Sender IDs registered on your account
POST /sms/sender-idsRegister a new Sender ID for approval
GET /sms/delivery-reportsRetrieve delivery status reports for sent messages
IVR, USSD, Email, and Payments endpoints are coming soon. Watch the changelog for announcements.

Authentication

Learn how to generate your API key and authenticate every request.

Send SMS

Send a single SMS message to any phone number.

Bulk Send

Launch a bulk SMS campaign to multiple recipients at once.

Webhooks

Receive real-time delivery and event notifications via webhooks.