API Reference
The NH.wacloud API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
All API requests should be prefixed with this base URL:
https://whatsapp.nsykat.com/api
Authentication
Authenticate your API requests by including your secret API key in the request headers. You can manage your API keys in the Developer settings of your dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Required Header
| API-Key | Your secret authentication token. |
Note: Alternatively, for webhook configurations or simple tests, you can pass the key in the query string: ?api_key=YOUR_KEY.
Create Campaign
Programmatically schedule a bulk messaging campaign to an existing contact group.
Parameters
| Parameter | Type | Description |
|---|---|---|
| name* | string | Name of the campaign. |
| message_template_id* | integer | ID of your pre-configured message template. |
| contact_group_id* | integer | ID of the contact group to send to. |
| scheduled_at | string (datetime) | Optional date to schedule sending (e.g. "2026-10-01 10:00:00"). |
| delay_min | integer | Minimum delay in seconds (default: 30). |
| smart_mix_enabled | boolean | Enable anti-ban smart device routing (1 or 0). |
Example Request
curl -X POST https://whatsapp.nsykat.com/api/create-campaign \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Black Friday Sale", "message_template_id": 12, "contact_group_id": 5, "scheduled_at": "2026-11-25 09:00:00", "smart_mix_enabled": 1 }'
Example Response
{
"status": "success",
"message": "Campaign created successfully.",
"data": {
"campaign_id": 45,
"name": "Black Friday Sale",
"status": "pending"
}
}
Send Message
POSTSends a WhatsApp message to the specified recipient. If the recipient is not on WhatsApp and Smart Fallback is enabled, the message is automatically routed via SMS.
Endpoint
Parameters
| Parameter | Description |
|---|---|
|
recipient
Required
|
The destination phone number including country code. Do not use '+', spaces, or dashes.
Example: 8801700000000
|
|
instance_id
Required
|
The unique Instance ID of the device you want to send the message from. |
|
content
Optional
|
The text content of your message. Required if you are not sending media. Supports WhatsApp markdown formatting. |
Smart Fallback & Webhooks
Our infrastructure automatically detects if a number is registered on WhatsApp. If a message fails delivery because the user does not have WhatsApp, the platform seamlessly triggers an SMS gateway API call.
To keep your CRM perfectly synced with the actual delivery method, configure a webhook endpoint in your dashboard to listen for the message.delivered event.