Oops! Facing network problem. Unable to load this page. Refresh

Please Wait...

Hello Guest

logo

FAQs

Help
Center

SMS Marketing

SMS API Integration

Integrate SMS messaging into your applications.

5 min read 30 Jul 2026 37 Views

Overview

The SPRL SMS API enables developers to integrate SMS functionality directly into their applications. Using secure REST API endpoints, you can send single or bulk SMS messages, manage contacts and contact groups, work with SMS templates, check delivery status, and monitor SMS credits.

The API uses HTTPS requests and API Key authentication. All SMS sent through the API must comply with DLT regulations by using approved Sender IDs and approved DLT Templates.

Good to Know:
All API requests must be authenticated using your Client ID and API Key. API requests should always be sent over HTTPS.

Access the API

  1. Navigate to Dashboard → API.
  2. Generate or copy your API Key.
  3. Review the available API endpoints.
  4. Integrate the required endpoints into your application.
  5. Monitor API activity and campaigns from the dashboard.

Authentication

Every API request requires authentication before it can be processed.

Requirement Description
Protocol HTTPS
Client ID Required with every API request.
API Key Sent in the Authorization header using the Bearer token format.
Content Type Supports JSON and application/x-www-form-urlencoded requests.

Available API Modules

The SMS API provides endpoints for sending messages and managing SMS resources.

Module Available Operations
Messages Send Single SMS, Send Bulk SMS, Send SMS to Contact Groups, Send Personalized SMS, Get Message Status, Get Bulk Message Status.
Contact Groups Get Groups, Create Group, Rename Group, Delete Group, Add Contacts, Block Contacts, Fetch Contacts.
SMS Templates List Templates, Create Template, Update Template, Delete Template.
Credits Check available SMS credit balance.

Sending an SMS

To send an SMS using the API, provide the required request parameters and authenticate the request using your API Key.

Parameter Description
client_id Your Client ID.
sender_id Your approved 6-character DLT Sender ID.
msgtype SMS category such as Promotional or Transactional.
mobile Recipient's 10-digit Indian mobile number.
Template Use an approved DLT template when sending messages.

API Campaigns

Every SMS sent through the API is recorded in the API Campaigns section.

Navigate to Dashboard → API → API Campaigns to review API-generated campaigns.

Information Description
Campaign API campaign name.
Campaign ID Unique campaign identifier.
Sender ID Sender ID used for the campaign.
Total Contacts Number of recipients.
Total SMS Total SMS credits consumed.
Status Current processing status.
Report View or download the campaign report.

API Call Monitoring

The API Calls section helps you monitor activity generated by your integrations. Reviewing API requests regularly helps verify that your application is communicating with the SMS platform correctly.

Before You Integrate

  • Complete your DLT registration.
  • Create approved Sender IDs.
  • Create approved DLT Templates.
  • Generate your API Key.
  • Purchase sufficient SMS credits.
  • Test your integration before using it in production.

Best Practices

  • Keep your API Key confidential.
  • Always use HTTPS for API requests.
  • Validate request parameters before sending.
  • Use approved Sender IDs and DLT Templates.
  • Review API Campaigns regularly to monitor successful requests.
  • Monitor your SMS credit balance before sending large volumes.

Troubleshooting

Authentication failed

Verify that your Client ID and API Key are correct and that the Authorization header is included with the request.

My SMS request was rejected

Ensure the Sender ID, message type, and DLT Template are valid and approved for the SMS being sent.

I cannot find my API campaign

Open Dashboard → API → API Campaigns to review campaigns created through the API.

My API request succeeds but no SMS is delivered

Review the campaign report and message status to identify any DLT, operator, or recipient-related delivery issues.

Frequently Asked Questions

Can I send both single and bulk SMS using the API?

Yes. The API provides endpoints for sending both single and bulk SMS messages.

Do I need an API Key?

Yes. All API requests require authentication using your API Key.

Can I manage Contact Groups using the API?

Yes. The API includes endpoints to create, rename, delete, and manage Contact Groups and their contacts.

Can I check my SMS credit balance through the API?

Yes. A dedicated endpoint is available to retrieve your current SMS credit balance.

Learn More:
Continue with SMS Marketing Best Practices to learn practical recommendations for improving campaign quality, maintaining DLT compliance, and using the SMS platform effectively.
Tip: Test your API integration with a small number of recipients before sending production traffic. This helps verify your authentication, Sender ID, DLT Template, and request parameters before processing larger SMS campaigns.

Related Articles

Getting Started with SMS Marketing
4 min read
How to Create an SMS Campaign
4 min read
Import SMS Contacts
3 min read
Transactional vs Promotional SMS
5 min read
SMS Delivery Reports Explained
4 min read
SMS Personalization with Variables
4 min read

Need more help?

Our support team is always happy to assist you.

Contact Support
×

We 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