twilnyx 0.2.0

A proxy that redirects Twilio SDK calls to Telnyx's API

Twilnyx

A proxy that redirects Twilio SDK calls to use Telnyx's API. Keep using your existing Twilio code and webhook server - just add two lines to use Telnyx instead!

Installation

pip install twilnyx

Usage

Your existing Twilio code:

from twilio.rest import Client

client = Client('TWILIO_ACCOUNT_SID', 'TWILIO_AUTH_TOKEN')

call = client.calls.create(
    url='https://your-server.com/voice',  # Your webhook server
    to='[phone]',
    from_='[phone]'
)

To use Telnyx instead, just add:

# Add these two lines at the start of your code
import twilnyx
twilnyx.use_telnyx(
    api_key='YOUR_TELNYX_API_KEY',
    voice_profile_id='YOUR_VOICE_PROFILE_ID',  # From Telnyx Portal > Voice > API Profiles
    connection_id='YOUR_CONNECTION_ID',  # From Telnyx Portal > Call Control > Apps
    debug=False  # Set to True for detailed logging
)

# Then use your existing Twilio code as-is!
from twilio.rest import Client
...

How It Works

1. Basic Flow:

   Your Code -> Twilio SDK -> Twilnyx Proxy -> Telnyx API
                                    |
                                    v
                             Parameter Mapping
                             Add Voice Profile
                             Convert Response
   

2. Complete Flow:

   +-------------+    +------------+    +-------------+    +-----------+
   |  Your Code  |    |Twilio SDK |    |Twilnyx Proxy|    |Telnyx API |
   |             |--->|           |--->|             |--->|           |
   +-------------+    +------------+    +-------------+    +-----------+
                                            |
                                            v
                                    +---------------+
                                    | Map Params    |
                                    | Add Profile   |
                                    | Map Response  |
                                    +---------------+
   

3. Webhook Flow:

   +-------------+    +------------+    +------------+
   |  Your App   |    |Telnyx API |    |Your Server |
   |client.calls |    |           |    |  /voice    |
   |             |--->|           |--->|            |
   |             |    |           |    |            |
   |             |    |           |<---|   TwiML    |
   +-------------+    +------------+    +------------+
   

4. Parameter Mapping:

   # Twilio format
   {
       'To': '[phone]',
       'From': '[phone]',
       'Url': 'https://your-server.com/voice'
   }
   
   # Converted to Telnyx format
   {
       'to': '[phone]',
       'from': '[phone]',
       'webhook_url': 'https://your-server.com/voice',
       'voice_profile_id': 'your_profile_id'  # Added automatically
   }
   

5. Response Conversion:

   # Telnyx response
   {
       'call_control_id': 'xyz',
       'state': 'ringing'
   }
   
   # Converted to Twilio format
   {
       'sid': 'xyz',
       'status': 'ringing'
   }
   

Required Setup

1. Telnyx API Key (Required):

   • Create in Telnyx Portal > Auth > API Keys
   • Used for authentication with Telnyx API
   • Pass to use_telnyx() as api_key

2. Telnyx Voice Profile (Required):

   • Create in Telnyx Portal > Voice > API Profiles
   • Used for outbound calling configuration
   • Pass the ID to use_telnyx() as voice_profile_id

3. Telnyx Call Control App (Required for calls):

   • Create in Telnyx Portal > Call Control > Apps
   • Configure with your webhook URL
   • Pass the ID to use_telnyx() as connection_id

4. Your Webhook Server:

   • Keep using your existing webhook server
   • It should return TwiML just like with Twilio
   • No changes needed to your webhooks

Features

• Uses your existing Twilio code
• Uses your existing webhook server
• No code changes needed
• Automatic parameter mapping
• Proper response conversion
• Detailed logging for debugging
• Support for calls and messages
• Error handling and reporting

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License