What You Can Test in Postman
Grouped by service. Every request below maps to an endpoint in the SMS API documentation or the WhatsApp API documentation.
- SMS:
apikeyrequest parameter - WhatsApp:
apikeyHTTP header
- Send SMS (
/api/web/send/) - Get single message status (
/api/status/message) - Get group status (
/status/group)
- Send OTP through the SMS send endpoint using your DLT-approved OTP template
- Generate and verify the OTP in your own backend
- Send approved template message
- Send text message (within 24 hours of the customer's last message)
- Upload media
- API documentation for Voice and RCS is shared on request — contact us.
- SMS delivery reports via
callbackurl+label - WhatsApp status webhooks (callback URL configured by SpringEdge support)
- Get SMS credit balance (
/api/status/credit)
Download & Import
There is no downloadable Postman collection file on this page. Instead, paste the cURL samples below into Postman via Import → Raw text — Postman auto-converts cURL to a request and keeps the {{variables}} so they resolve from your environment.
Need a ready-made collection for your team? Contact us and we'll help you get set up.
Postman Setup — 2 Minutes
phone_number_id after WhatsApp onboarding.SMS_SERVICE_URL, SMS_API_KEY, WHATSAPP_SERVICE_URL, WHATSAPP_API_KEY and phone_number_id. Mark the API keys as secret.Sample Requests — Paste into Postman
Copy any of these cURL snippets, open Postman, click Import, paste under the Raw text tab, and Postman auto-builds the request. {{SMS_SERVICE_URL}} is your SMS service URL (<SMS_SERVICE_URL> in our docs), shared after sign-up. SMS requests are form-encoded (application/x-www-form-urlencoded); parameter names are case-sensitive and the message must match a DLT-approved template.
Send Transactional SMS
Response:
Send OTP
Get Delivery Status
Status values: SUBMITTED, AWAITED-DLR, DELIVRD, UNDELIVRD, REJECTED. For every message in a send request, use the group status endpoint:
Get Credit Balance
Send WhatsApp Template Message
The first message to a customer must be an approved template. {{WHATSAPP_SERVICE_URL}} is your WhatsApp service URL (<WHATSAPP_SERVICE_URL> in our docs).
Response:
Upload WhatsApp Media
Authentication
Both APIs authenticate with an API key — there is no Bearer token or Authorization header. The key is passed differently per API:
- SMS / OTP API —
apikey=YOUR_API_KEYas a request parameter (form field for POST, query string for GET) - WhatsApp API —
apikey: YOUR_API_KEYHTTP header
For Postman, store your keys in the environment variables SMS_API_KEY and WHATSAPP_API_KEY and reference them as {{SMS_API_KEY}} / {{WHATSAPP_API_KEY}}. Your SMS API key can be restricted to whitelisted IPs. In production, call the API only from your server — never from browser, front-end or mobile-app code, where the key would be exposed.
Common SMS API Errors
The SMS API returns errors as plain-text messages. Full list in the SMS API documentation.
| Error Message | Meaning | Fix |
|---|---|---|
| Invalid Input Data | Missing or malformed parameter | Check parameter names (case-sensitive) and URL-encode all values. |
| Account Inactive. Please contact Support | Account is not active | Contact support. |
| Invalid Mobile Numbers | Recipient number not valid | Use a 10-digit Indian mobile number; the 91/+91 prefix is optional. |
| Invalid Sender ID | Sender not approved | Use your approved 6-character DLT sender ID. |
| Insufficient Credits | Not enough balance | Check /api/status/credit and recharge. |
| Invalid Message GID | Unknown group ID in a status request | Use the groupID returned by the send request. |
| Invalid Schedule Date and Time! / Invalid Schedule Date! | Schedule value not valid | Correct the schedule date/time. |
The SMS API accepts up to 10 requests per second per IP — keep Postman Runner iterations within that limit.
Webhook Testing in Postman
To receive SMS delivery reports, add callbackurl and label to your send request. SpringEdge then calls your URL with the parameters label, recipient and status (DELIVRD, UNDLIVRD, FAILED). During development, you don't need a real public endpoint — tools like webhook.site or RequestBin give you a temporary URL that captures incoming requests for inspection.
Workflow:
- Get a temporary URL from webhook.site.
- Pass it as
callbackurl, with your own reference aslabel, in the Send SMS request. - Send the request from Postman.
- Watch the
label,recipientandstatusparameters arrive at webhook.site. - In production, read the parameters from the request (e.g. PHP
$_REQUEST) and respond with HTTP 200 quickly.
For WhatsApp status webhooks, share your callback URL with SpringEdge support; events arrive in Meta's webhook format. See WhatsApp webhooks.
Common Use Cases
Pre-Integration Testing
Confirm the API behaves as expected before writing application code.
QA Test Runs
QA team triggers SMS / WhatsApp / OTP flows to test recipient phones.
Support Reproduction
Reproduce customer-reported issues with the exact request payload.
Stakeholder Demos
Show product/sales teams how messages render on a real phone.
Frequently Asked Questions
springedge npm package.Get your API key in 2 minutes — start testing today
Free signup, free test credits, no credit card. Paste the cURL samples above into Postman and send your first SMS.
