All requests must include the
Authorization: Bearer YOUR_API_KEY header. Requests and responses use Content-Type: application/json.Endpoint
Request
Request Body Parameters
string
required
Your registered and approved Sender ID. This value is applied to every message in the batch. Maximum 11 alphanumeric characters.
array
required
An array of message objects to send. Each object must include the following fields:
string
required
Recipient phone number in E.164 format (e.g.
+233201234567).string
required
The SMS message body for this recipient. Messages longer than 160 characters are split into segments; each segment consumes 1 credit.
string
An HTTPS URL to receive delivery status webhook events for each individual message in the batch. The URL must be publicly reachable.
Response
200 — Success
Response Fields
string
Indicates the outcome of the request. Either
"success" or "error".string
Unique identifier for this campaign batch. Use this value to filter delivery reports via the Delivery Reports endpoint.
integer
The total number of messages submitted in this request.
integer
The number of messages successfully accepted and queued for delivery. If any messages failed validation,
queued will be less than total.integer
The total number of credits consumed across all queued messages.
integer
Your account’s remaining credit balance after this bulk send.
Tips and Limits
For campaigns exceeding 10,000 recipients, contact Hany support for optimized batch processing and dedicated throughput.