API Documentation
Complete reference for the WRNexus REST API
Quick Start
Get started with the WRNexus API
Base URL
https://api.wrnexus.com/api/v1
Authentication
Authorization: Bearer <your-api-key>
Example Request
curl -X POST https://api.wrnexus.com/api/v1/sms/send \
-H "Authorization: Bearer wrn_live_abc123..." \
-H "Content-Type: application/json" \
-d '{
"to": "+919876543210",
"message": "Hello from WRNexus!",
"sender_id": "MYSHOP"
}'99.9%
Uptime SLA
<100ms
Avg Response
10K/min
Rate Limit
v1
Current Version
Authentication
User authentication and session management
| Method | Endpoint | Action |
|---|---|---|
| POST | /api/v1/auth/login | |
| POST | /api/v1/auth/register | |
| POST | /api/v1/auth/refresh | |
| POST | /api/v1/auth/logout | |
| POST | /api/v1/auth/verify-email | |
| POST | /api/v1/auth/reset-password |
SMS
SMS messaging and campaign management
| Method | Endpoint | Action |
|---|---|---|
| POST | /api/v1/sms/send | |
| POST | /api/v1/sms/bulk | |
| GET | /api/v1/sms/campaigns | |
| POST | /api/v1/sms/campaigns | |
| GET | /api/v1/sms/campaigns/:id | |
| GET | /api/v1/sms/delivery/:id | |
| GET | /api/v1/sms/templates | |
| POST | /api/v1/sms/templates |
Email
Email messaging and automation
| Method | Endpoint | Action |
|---|---|---|
| POST | /api/v1/email/send | |
| POST | /api/v1/email/bulk | |
| GET | /api/v1/email/campaigns | |
| POST | /api/v1/email/campaigns | |
| GET | /api/v1/email/templates | |
| POST | /api/v1/email/templates |
Contacts
Contact and group management
| Method | Endpoint | Action |
|---|---|---|
| GET | /api/v1/contacts | |
| POST | /api/v1/contacts | |
| GET | /api/v1/contacts/:id | |
| PUT | /api/v1/contacts/:id | |
| DELETE | /api/v1/contacts/:id | |
| GET | /api/v1/contacts/groups | |
| POST | /api/v1/contacts/groups | |
| POST | /api/v1/contacts/import |
Credits
Credit balance and transactions
| Method | Endpoint | Action |
|---|---|---|
| GET | /api/v1/credits/balance | |
| GET | /api/v1/credits/transactions | |
| POST | /api/v1/credits/purchase | |
| POST | /api/v1/credits/transfer |
Analytics
Reports and analytics data
| Method | Endpoint | Action |
|---|---|---|
| GET | /api/v1/analytics/overview | |
| GET | /api/v1/analytics/sms | |
| GET | /api/v1/analytics/email | |
| GET | /api/v1/reports | |
| POST | /api/v1/reports |
Webhooks
Webhook configuration and events
| Method | Endpoint | Action |
|---|---|---|
| GET | /api/v1/webhooks | |
| POST | /api/v1/webhooks | |
| PUT | /api/v1/webhooks/:id | |
| DELETE | /api/v1/webhooks/:id | |
| GET | /api/v1/webhooks/:id/logs |
Response Codes
Standard HTTP response codes used by the API
Success Codes
200 OK - Request successful 201 Created - Resource created 202 Accepted - Request queued 204 No Content - Deleted Error Codes
400 Bad Request - Invalid input 401 Unauthorized - Invalid API key 403 Forbidden - Access denied 404 Not Found - Resource missing 429 Too Many Requests - Rate limited 500 Server Error - Internal error SDKs & Libraries
Official client libraries for popular languages