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.
In India, SMS messages for commercial or transactional use must comply with DLT (Distributed Ledger Technology) regulations mandated by TRAI. To meet these requirements, SPRL offers the Nested Route SMS DLT API which allows you to generate short URLs embedded in SMS content using approved sender headers and templates - all in a compliant, traceable manner.
This API leverages nested routing so that SMS messages containing links are sent only via DLT-registered templates/routes, ensuring regulatory compliance and higher delivery reliability.
| Method | POST |
|---|---|
| API Endpoint | https://insprl.com/api/url/short-url-nested-route |
| 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" for this Parameter |
| long_url | Url | Required | The URL which you want to get shorter. |
| tag_type | String | Required |
|
| tag_keyword | String | Conditional | Tag keyword is required if tag_type is "custom". |
| nested_path | String | Required, Max 50 chars, Pattern: ^[a-zA-Z0-9\-_]+ $ | Nested route to append to the short URL. Only letters, numbers, hyphens, and underscores are allowed. |
| domain | String | Optional | Specify if you want to use custom domain |
| expiry_date | Date | Optional | Date format: dd-mm-yyyy |
| Parameter | Type | Description |
|---|---|---|
| code | Numeric | Find the code information below under "API Codes" |
| message | String / Array | As per the request handler |
| short_url | url | New Shorten URL |
| 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
