Skip to main content

What's Included in the Collection

Grouped by service, with sample request bodies, environment variables, and example responses.

Authentication
  • Set API key as environment variable
  • Verify API key health
SMS
  • Send single SMS
  • Send bulk SMS
  • Get delivery status
  • Schedule SMS for later
OTP
  • Send OTP
  • Verify OTP
  • Resend OTP
WhatsApp
  • Send template message
  • Send session message (within 24-hour window)
  • Upload media (image, document, video)
Voice
  • Start voice broadcast campaign
  • Get campaign status
  • List campaigns
RCS
  • Send rich card
  • Send carousel
  • Send with SMS fallback
Webhooks
  • Test webhook endpoint
  • Simulate delivery report
Account
  • Get wallet balance
  • List sender IDs
  • List approved templates

Download & Import Coming Soon

The downloadable Postman collection (JSON) is being finalised. In the meantime, the cURL samples below can be pasted directly into Postman via File → Import → Raw text — Postman auto-converts cURL to a request.

Want notification when the JSON collection is ready? Sign up free — we'll email you and you'll get your API key in the same flow.

Postman Setup — 2 Minutes

1.Sign up free at /signup — no credit card.
2.Get your API key from the dashboard (Settings → API).
3.Open Postman → Environments → New environment.
4.Add a variable named api_key with your value.
5.Import the collection (or paste the cURL samples below).
6.Run "Send Test SMS" to verify your setup works end-to-end.

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. Replace YOUR_API_KEY with your actual key (or use Postman's {{api_key}} variable).

Send Transactional SMS

curl "https://web.springedge.com/web/api/send/?apikey=YOUR_API_KEY&sender=SPEDGE&to=919876543210&message=Your+order+ORD-7841+has+been+shipped"

Send OTP

curl "https://web.springedge.com/web/api/send/?apikey=YOUR_API_KEY&sender=SPEDGE&to=919876543210&message=Your+OTP+is+482917.+Valid+for+5+minutes."

Send WhatsApp Template Message

curl -X POST https://api.springedge.com/whatsapp/v1/messages \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "919876543210", "type": "template", "template": { "name": "order_confirmation", "language": { "code": "en" }, "components": [{ "type": "body", "parameters": [ { "type": "text", "text": "Priya" }, { "type": "text", "text": "ORD-7841" } ]}] } }'

Get Delivery Status

curl "https://web.springedge.com/web/api/status/?apikey=YOUR_API_KEY&message_id=msg_8f2ab1d3"

Authentication

The SpringEdge SMS/Voice API uses an apikey query parameter. The WhatsApp API uses a Bearer token in the Authorization header. Both use the same API key value — just passed differently:

  • SMS / Voice / OTP API?apikey=YOUR_API_KEY (query param)
  • WhatsApp APIAuthorization: Bearer YOUR_API_KEY (header)

For Postman, store your key in an environment variable named api_key. Reference it as {{api_key}} anywhere in URL or headers.

Common Error Codes

HTTP Status Error Fix
401Invalid API keyVerify the key from your dashboard. Check for trailing whitespace.
403IP not whitelistedAdd your server IP in dashboard → Security → IP whitelist.
422Invalid template / senderUse a DLT-approved template body and an approved sender ID.
429Rate limit exceededReduce request rate (default 100/sec). Implement exponential backoff.
500Internal errorRetry after 1-2 seconds. If persistent, contact support.
503Service unavailableOperator route degraded. Auto-retry will engage; check status page.

Webhook Testing in Postman

SpringEdge sends delivery reports to your webhook URL via HTTP POST with JSON body. During development, you don't need a real public endpoint — tools like webhook.site or RequestBin give you a temporary URL that captures incoming webhooks for inspection.

Workflow:

  1. Get a temporary URL from webhook.site.
  2. Set it as your webhook URL in SpringEdge dashboard → Settings → Webhooks.
  3. Send a test SMS or OTP from Postman.
  4. Watch the delivery report arrive at webhook.site.
  5. Use Postman's "Mock Server" to design your production webhook handler before deploying.

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

The downloadable JSON file is being finalised. Sign up free to be notified when it's ready — in the meantime, paste the cURL samples on this page directly into Postman via Import → Raw text.

Sign up at /signup. Your API key is available immediately in the dashboard under Settings → API. No verification or sales call required.

No — the API requires authentication. Signup is free with no credit card; takes under 2 minutes including email verification.

Postman is great for development and ad-hoc testing. For production traffic, integrate the API into your backend using one of the SpringEdge SDKs (PHP, Node.js, Python, Java, Ruby, C#, Android).

No. The same production endpoints work for testing, using your free test credits. This means your Postman requests work unchanged when you move to production.

Yes. Use Postman's team workspaces to share the collection and environment. Each teammate uses their own personal API key for security; share the collection structure, not the key.

Yes. Use Postman Monitors to schedule periodic API health checks (e.g. send a test OTP every hour and assert delivery). Useful for continuous monitoring of your integration's end-to-end behaviour.

For Postman-application issues check Postman's docs. For SpringEdge API issues (auth failures, malformed requests, delivery questions) contact our support team — we usually respond within 2 business hours.

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.

Get API Key Free View Full API Docs