Developer Portal | TelzLink API Documentation

Quick Start

Get started in 5 minutes with your first API call

1. Get Your API Credentials

# Your API credentials
API_KEY = "your_api_key_here"
API_SECRET = "your_api_secret_here"
                

2. Make Your First API Call

Here's a simple example to get your account information:

import requests

# Initialize client
api_key = "your_api_key"
api_secret = "your_secret"

# Get account info
response = requests.get(
    "https://api.telzlink.com/v1/account",
    auth=(api_key, api_secret)
)

print(response.json())
                

3. Search for Available Numbers

import requests

# Search for US numbers with area code 415
response = requests.get(
    "https://api.telzlink.com/v1/numbers/search",
    params={
        "country": "US",
        "area_code": "415",
        "type": "local"
    },
    auth=(api_key, api_secret)
)

numbers = response.json()["numbers"]
print(f"Found {len(numbers)} available numbers")
                

4. Purchase a Number

# Purchase a number
response = requests.post(
    "https://api.telzlink.com/v1/numbers",
    json={
        "number": "+14155551234",
        "webhook_url": "https://yourapp.com/webhook"
    },
    auth=(api_key, api_secret)
)

print("Number purchased successfully!")
                

API Reference

Complete REST API documentation

Authentication

All API requests require authentication using HTTP Basic Auth with your API key and secret.

Base URL: https://api.telzlink.com/v1/

Numbers API

GET /numbers/search

Search for available phone numbers

Query Parameters:

country - ISO country code (e.g., US, GB)
area_code - Area code to search within
type - Number type: local, toll-free, mobile
pattern - Search pattern (e.g., *555*)

POST /numbers

Purchase a phone number

Body Parameters:

number - Phone number to purchase (E.164 format)
webhook_url - URL for incoming call/SMS webhooks
name - Friendly name for the number

GET /numbers

List your numbers

Returns all phone numbers in your account with their configuration.

Calls API

POST /calls

Make an outbound call

Body Parameters:

from - Your TelzLink number
to - Destination number (E.164 format)
url - TwiML URL for call flow
method - HTTP method (GET/POST)

GET /calls/{call_id}

Get call details

Returns detailed information about a specific call including duration, status, and recordings.

SMS API

POST /messages

Send an SMS message

Body Parameters:

from - Your TelzLink number
to - Destination number
body - Message text (up to 1,600 characters)
media_url - Optional MMS media URL

View Full API Documentation →

Official SDKs

Native libraries for your favorite programming languages

🐍

Python

pip install telzlink

Documentation

📗

Node.js

npm install telzlink

Documentation

🐘

PHP

composer require telzlink/sdk

Documentation

💎

Ruby

gem install telzlink

Documentation

☕

Java

Maven/Gradle available

Documentation

🔷

Go

go get telzlink-go

Documentation

API Playground

Test API calls in real-time without writing code

Try It Out

Test API endpoints with your credentials

API Endpoint

Request Body (JSON)

Response

// Response will appear here

Webhooks

Real-time notifications for incoming calls, messages, and events

TelzLink sends HTTP POST requests to your webhook URL when events occur:

✓ Incoming calls
✓ Incoming SMS messages
✓ Call status changes (ringing, answered, completed)
✓ Recording available
✓ Voicemail received

Example Webhook Handler

from flask import Flask, request

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def handle_webhook():
    data = request.json
    
    if data['event'] == 'incoming_call':
        from_number = data['from']
        print(f"Incoming call from {from_number}")
        
        # Return TwiML to control the call
        return '''
        
            Thank you for calling. Please hold.
            +14155551234
        
        '''
                

Ready to Build?

Get your API keys and start building powerful telecommunications features today

Get API Keys Free Talk to Developer Support