Neopolis Postman examples

NEOPOLIS POSTMAN EXAMPLES - START HERE

WHAT IS THIS?
Ready-made requests for testing the Neopolis API in Postman.
The JSON file is imported into Postman. It is not an installer.
You do not need to read or edit that JSON file yourself.

1. INSTALL POSTMAN
Get it from https://www.postman.com/downloads/

2. IMPORT THE EXAMPLES
Unzip this download. Open Postman and choose Import.
Select Neopolis-API.postman_collection.json.
The Neopolis SMS API collection contains the ready-made requests.

3. SET UP YOUR CONNECTION
Create an app in Neopolis under Apps & API Keys and copy its API key.
Open the imported collection's variables in Postman:
  baseUrl = https://www.neopolis.net
  apiKey = your np_live_ key, NOT your sign-in password
Keep the API key private. Use private/local variable values where available.
Do not share or export these examples after adding your real key.
The requests inherit Bearer authentication from the collection.

4. YOUR FIRST TEST - NO TEXT SENT
Choose Validate without sending or reserving funds.
Inspect Body, which contains raw JSON. Change the recipient to your own
permitted mobile number in U.S. E.164 format, such as +12105550199.
Before 10DLC approval, use the account owner's verified mobile number.
Click Send. Read the HTTP status and JSON response below the request.
This checks your request and estimates cost; no text or reservation occurs.
Postman contacts your real account. For fictional-number simulation, use
the separate free Developer Playground.

5. SEND A REAL MESSAGE - BILLABLE
Choose Queue SMS or MMS only when ready for a real text.
Check the recipient and body carefully.
Set idempotencyKey to a NEW unique value for each new message.
For a retry of the SAME message, preserve BOTH the key and JSON.
Click Send. This uses your prepaid balance.
HTTP 202 means accepted for processing, not delivered.
Copy the returned id into the messageId variable.
Choose Get account message status and click Send to check delivery.

6. OTHER REQUESTS
List account messages: see recent message records.
Balance and test restrictions: inspect available balance and restrictions.
Active dedicated numbers: find your available sending numbers.
Upload one JPEG/PNG/GIF: select your image in the file form-data field.
Check MMS draft / check: validate image limits and draft preparation.
Download an account image: supply the media ID from an upload or message.
Use the full documentation for exact field names and endpoint rules.

7. ERRORS
Read the response's error, message and requestId.
400: check JSON and field values. 401: check your active API key.
402: check account balance. For other errors, read the returned explanation.
Do not keep retrying a live send with new keys: that can send duplicates.
Registration, consent, opt-out and balance rules still apply in Postman.

8. WEBHOOKS
Configure your public HTTPS receiver under Apps & API Keys.
Use Send webhook test there and inspect delivery history.
Events go to your receiver, not the Postman response window.

FULL DOCUMENTATION
https://www.neopolis.net/developers#postman