Getting Started with the Simple Telecom REST API
Your Complete Guide to Getting Started with the Simple Telecom API — Authentication, Endpoints, and First Steps
Quick Start Checklist
- Generate your API token from the Simple Telecom console
- Test your token with the Services API endpoint
- Retrieve your first CDR records with date filtering
- View your current routing configuration
- Explore code examples in PHP, JavaScript, and cURL
Welcome to the Simple Telecom API
The Simple Telecom API gives you programmatic access to your Australian telecom services. Whether you’re building a CRM integration, setting up automated call tracking, or creating a custom analytics dashboard, this guide will help you get started quickly. The API is RESTful, uses standard Bearer token authentication, and returns clean JSON responses.
Before you begin, make sure you have an active Simple Telecom account with at least one service number — a 1300, 1800, or CTN number. API access is included with your service at no additional cost. There are no API usage fees or tiered pricing.
This guide covers the complete setup process: generating your API token, making your first API call, exploring the three core API areas, and understanding error handling. By the end, you’ll have everything you need to start building your integration.
Step 1: Generate Your API Token
Your API token is the key to accessing the Simple Telecom API. Follow these steps to generate one:
1. Log in to your Simple Telecom console at console.simpletelecom.com.au.
2. Navigate to Settings → API Access.
3. Click ‘Generate API Token’. Your token will appear in the format st_... followed by a unique string.
4. Copy and store your token immediately. It’s shown only once. If you lose it, revoke the old token and generate a new one.
Your token is now active. Store it securely — use environment variables, a secrets manager, or a secure configuration file. Never hardcode it in source code or share it publicly.
Step 2: Make Your First API Call
Once you have your token, test it by calling the Services API. This is the simplest endpoint and a great way to confirm your authentication is working. Use cURL from your terminal:
curl -X GET "https://api.simpletelecom.com.au/v1/api/services" -H "Authorization: Bearer st_your_token_here"
If successful, you’ll receive a JSON response listing your active services. Each service entry includes the service_id, service_number, service_type (1300, 1800, or CTN), and status. If you see your services listed, your API access is working correctly.
If you receive a 401 Unauthorized error, double-check that your token is correct and properly formatted in the Authorization header. The header must use the exact format: Authorization: Bearer st_your_token_here.
If you get a blank token error, go back to the console and generate a new token — API access may be disabled on your account.
Step 3: Explore the Three Core API Areas
With your token confirmed working, explore the three core API areas:
Services API (GET /api/services): Lists all active services on your account. Use this to discover your service IDs and numbers. The response includes service_type (1300, 1800, CTN) and status.
CDR API (GET /api/cdrs): Retrieves call detail records. You need a service_number parameter (from the Services API response). Add optional start_date and end_date filters. Each record includes call timing, duration, source number, destination, and cost.
Routing Management API (multiple endpoints): View and manage call routing. Start with GET /api/services/{service_id}/routing to see your current configuration. Then try POST to add a forwarding number, PUT to update one, or DELETE to remove one.
Together, these three APIs give you complete programmatic control over your telecom services.
Step 4: Understand Error Handling
All API errors return a consistent JSON structure with status (HTTP status code), code (machine-readable error code), and message (human-readable description). Understanding these errors helps you build robust integrations.
Common error codes: unauthorized (401) means your token is missing or invalid. missing_parameter (400) means a required field like service_number was not provided. invalid_date_format (400) means a date doesn’t match YYYY-MM-DD format. service_not_found (404) means the service ID doesn’t exist. too_many_requests (429) means you’ve exceeded the rate limit.
Always check the response status code and handle errors appropriately in your integration. Implement retry logic with backoff for rate limiting errors (429) and temporary server errors (500). For authentication errors (401), notify the user that their token may need to be regenerated.
Next Steps: Building Your Integration
Once you’ve completed the steps above, you’re ready to build your integration. Here are some common next steps depending on your goals:
For CRM Integration: Set up a scheduled task that queries the CDR API every 5–15 minutes, identifies new call records, and pushes them to your CRM. Map the source_number to CRM contacts, and create call activities or new leads as appropriate.
For Marketing Attribution: Assign unique 1300 or 1800 numbers to each marketing channel. Use the CDR API to pull call data per number and feed it into your analytics platform. Calculate cost-per-lead per channel and optimise your marketing spend.
For Routing Automation: Create scheduled scripts that update routing configurations based on time of day, staff availability, or campaign schedules. Use the Routing API to add, update, and remove forwarding numbers programmatically.
Full documentation with code examples in PHP, JavaScript, and cURL is available at api.simpletelecom.com.au. For help, contact api-support@simpletelecom.com.au.
Frequently Asked Questions
Frequently Asked Questions About Getting Started
Do I need a developer to use the API?
Basic API usage — making cURL requests, retrieving data — requires some technical comfort. For full integration with CRM or analytics platforms, you’ll need development skills or access to a developer.
Is there a sandbox or test environment?
The API uses your live account data. We recommend testing with a non-critical service number first, and validating your integration thoroughly before deploying to production.
What programming languages can I use?
The API is RESTful and works with any language that supports HTTP requests. Code examples are provided in PHP, JavaScript (fetch), and cURL. Python, Ruby, Java, Go, and other languages work equally well.
How much does API access cost?
API access is included with your Simple Telecom service at no additional cost. There are no API usage fees, tiered pricing, or request limits that affect your bill.
Where can I find the full API documentation?
Full documentation is available at api.simpletelecom.com.au. It includes detailed endpoint descriptions, request/response examples, error codes, and code samples for each endpoint.
The Simple Telecom REST API gives Australian businesses powerful tools to integrate virtual phone solutions into their systems seamlessly. Whether you’re implementing how 1300 numbers work in Australia or setting up advanced features, the API supports everything from call management to customer insights. You can even leverage call tracking metrics API functionality to monitor performance, or use our 1300 number reverse lookup Australia free service to verify caller details—all through straightforward API calls that help you establish a professional national presence without complexity.
