Please Wait...
Use your Client ID (payload) and API Key (header) to authenticate requests. All requests must be made over HTTPS. API usage is subject to rate limits.
| Method | POST |
|---|---|
| API Endpoint | https://insprl.com/api/whatsapp/v1/campaigns/tracking |
| Authentication | Required How to Generate API keys? |
| Header | Yes | Description |
|---|---|---|
| Authorization | Yes | Bearer {CLIENT_KEY} |
| Content-Type | JSON | Supported values:
|
| Parameter | Type | Validate | Description |
|---|---|---|---|
| client_id | String | Required | Use your "CLIENT ID" |
| account_id | String | Required | Your WhatsApp Account UID |
| campaign_uid | String | Required | Unique Campaign Identifier |
| per_page | Integer | Optional (1–100) | Number of records per page (default: 50) |
| status | String | Optional | Filter contacts by status (pending, sent, delivered, read, failed, replied) |
| phone | String | Optional | Search contacts by phone number |
| Parameter | Type | Description |
|---|---|---|
| status | Boolean | Request status (true/false) |
| code | Numeric | API status code |
| data.campaign | Object | Campaign summary details |
| campaign_id | String | Campaign UID |
| name | String | Campaign name |
| status | String | Campaign status (queued, scheduled, running, completed) |
| total | Integer | Total contacts count |
| accepted | Integer | Total accepted messages |
| sent | Integer | Total sent messages |
| delivered | Integer | Total delivered messages |
| delivery_rate | Float | Delivery percentage |
| read | Integer | Total read messages |
| replied | Integer | Total replied messages |
| failed | Integer | Total failed messages |
| created_at | DateTime | Campaign creation time |
| data.contacts | Array | List of campaign contacts |
| phone | String | Recipient phone number |
| status | String | Message status |
| message_id | String | WhatsApp message ID |
| created_at | DateTime | Message created time |
| sent_at | DateTime | Message sent time |
| delivered_at | DateTime | Message delivered time |
| read_at | DateTime | Message read time |
| replied_at | DateTime | Reply received time |
| data.pagination | Object | Pagination details |
| current_page | Integer | Current page number |
| last_page | Integer | Total number of pages |
| per_page | Integer | Records per page |
| total | Integer | Total contacts count |
| SPRL Code | HTTP Status | Mode | Response Field | Description |
|---|---|---|---|---|
| 100 | 200 | success | data | Request processed successfully. |
| 101 | 401 | failed | message | Authentication failed. Invalid or missing API credentials. |
| 102 | 422 | failed | errors | Parameter validation failed. Check the input fields. |
| 103 | 403 | failed | error | SPRL account is restricted (temporary or permanent block). |
| 104 | 400 | failed | errors | Insufficient wallet balance. Recharge required. |
| 105 | 500 | failed | message | Unexpected server error. Please try again later. |
| 129 | 429 | failed | errors | API usage limit exceeded (daily, monthly, or total). |
| Category | Flag | Type | Description |
|---|---|---|---|
| Account | ACCOUNT_PERMANENT_BLOCKED | account_restricted | The SPRL account has been permanently blocked. |
| Account | ACCOUNT_TEMP_BLOCKED | account_restricted | The SPRL account has been temporarily restricted. |
| Billing | INSUFFICIENT_BALANCE | billing_error | The wallet balance is insufficient to process the request. |
| Rate Limit | DAILY_LIMIT_REACHED | rate_limit_exceeded | The daily API usage limit has been exceeded. |
| Rate Limit | MONTHLY_LIMIT_REACHED | rate_limit_exceeded | The monthly API usage limit has been exceeded. |
| Rate Limit | TOTAL_LIMIT_REACHED | rate_limit_exceeded | The total API usage limit has been exceeded. |
| Validation | INVALID_PARAMETER | validation_error | One or more request parameters are invalid. |
| Authentication | INVALID_CREDENTIALS | auth_error | API credentials are missing or invalid. |
| Server | UNEXPECTED_ERROR | server_error | An unexpected internal server error occurred. |
We follow industry best practices for API security and data protection.
Our APIs are designed with authentication, rate limiting, and continuous security review.
Easy and Quick way to shorten link with SPRL!
Please feel free to contact us at 8088 948 172 for support.
Contact UsWe use cookies to improve your experience, analyse traffic, and personalise content. By clicking “Accept”, you consent to the use of cookies as described in our Cookie Policy .
Accept cookies Read our Cookie Policy
