Postman Collection Guide
Get started quickly with our comprehensive Postman collection. Includes all API endpoints with pre-configured requests, automatic variable management, and example workflows.
What's Included
- 130+ pre-configured API requests across all services
- Automatic token refresh and variable management
- Pre/post-request scripts for seamless testing
- Example data and realistic payloads
Download Collection
Download the complete Postman collection with all API endpoints, authentication, and example requests.
Collection File
Vobiz_API_Collection.postman_collection.jsonLatest version - Updated with all endpoints from Gateway, Account, Trunk, Number, Balance, and CDR services
Import into Postman
Step 1: Open Postman
Launch Postman desktop app or visit postman.com for the web version.
Step 2: Import Collection
- Click Import button in the top-left corner
- Drag and drop the JSON file or click Upload Files
- Select
Vobiz_API_Collection.postman_collection.json - Click Import to confirm
Step 3: Verify Import
You should see a new collection named "VoBiz SIP Trunking Platform" in your Collections sidebar with the following folders:
- Gateway
- Account Service → Authentication
- Account Service → Accounts
- Account Service → Sub-Accounts
- Trunk Service
- Number Service
- Balance Service
- CDR Processor
Environment Setup
Create a Postman environment to manage API base URLs and credentials across different deployment stages.
Create New Environment
- Click the Environments tab in the left sidebar
- Click Create Environment or the + button
- Name it "Vobiz - Production" (or Development/Staging)
Configure Variables
| Variable | Initial Value | Description |
|---|---|---|
base_url | https://api.vobiz.ai | API base URL |
email | your@email.com | Your account email |
password | yourpassword | Your account password |
access_token | (leave empty) | Auto-populated after login |
refresh_token | (leave empty) | Auto-populated after login |
accountId | (leave empty) | Auto-populated after login |
Activate Environment
Select your environment from the dropdown in the top-right corner of Postman. The collection will automatically use these variables in all requests.
Configure Authentication
The collection includes automatic authentication handling via pre-request scripts.
Automatic Login Flow
- Open the Authentication folder
- Run the Login request
- The script will automatically save
access_token,refresh_token, andaccountIdto your environment - All subsequent requests will use these tokens in the
Authorizationheader
Token Refresh
If your access token expires (default: 30 minutes), simply run the Refresh Access Token request. The new token will be automatically saved to your environment.
Security Note
Never commit environment files with real credentials to version control. Use separate environments for development, staging, and production.
Testing Workflow
Follow this recommended workflow to test the complete API stack:
1. Authentication
- Login with your provided credentials → saves tokens automatically
- Get Current User Info → verify authentication
2. SIP Trunk Provisioning
- Create SIP Trunk → note the
trunkId - List SIP Trunks → verify creation
- Get SIP Trunk Details → check domain assignment
3. Balance Management
- Get Balance → check initial balance
- Credit Balance → add funds
- List Transactions → verify credit
4. Phone Numbers
- Search Numbers → find available numbers
- Purchase Number → buy a number
- Assign to Trunk → link number to trunk
- List Numbers → verify ownership
5. Call Testing
- Configure your SIP client with trunk credentials
- Make test calls
- List CDRs → verify call records
- Check Balance → confirm call deductions
Collection Variables
The collection uses variables to chain requests together seamlessly. These are automatically set by post-request scripts:
| Variable | Set By | Used In |
|---|---|---|
access_token | Login request | All authenticated endpoints |
accountId | Login request | Account-scoped API paths |
trunkId | Create Trunk | Get/Update/Delete trunk requests |
numberId | Purchase Number | Assign/Release number requests |
subAccountId | Create Sub-Account | Sub-account operations |
routingRuleId | Create Routing Rule | Update/Delete routing rule |
Tips & Tricks
Use Collection Runner
Select the collection → Click Run → Execute all requests sequentially to test the entire workflow. Great for regression testing after API changes.
Console Debugging
Open Postman Console (View → Show Postman Console) to see detailed request/response logs, including pre-request script output and variable changes.
Save Responses as Examples
After successful requests, click Save Response → Save as Example. This helps document expected response formats for your team.
Export for CI/CD
Use Newman (Postman's CLI) to run collections in your CI/CD pipeline:npm install -g newman
newman run collection.json -e environment.json
Mock Servers
Create a Postman Mock Server from the collection for frontend development before backend APIs are ready. Right-click collection → Mock Collection.