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='+1234567890',
from_='+1987654321'
)
To use TeXML, just add:
# Add these two lines at the start of your code
import twilnyx
twilnyx.use_telnyx(debug=True) # Set to True for detailed logging
# Then use your existing Twilio code as-is!
from twilio.rest import Client
...
TeXML Mode
This package uses TeXML exclusively for all requests. No Telnyx API credentials are required, as all requests are handled via TeXML responses.
# Simple usage with TeXML - loads full mappings by default
import twilnyx
twilnyx.use_telnyx() # No credentials needed, supports all TwiML verbs
# Your existing Twilio code works as-is
from twilio.rest import Client
client = Client('TWILIO_ACCOUNT_SID', 'TWILIO_AUTH_TOKEN')
Custom Mappings
You can customize the parameter mappings and TeXML templates by providing your own JSON file:
import twilnyx
# Option 1: Load custom mappings at initialization
twilnyx.use_telnyx(custom_mappings_file='my_mappings.json')
# Option 2: Load custom mappings at any time
twilnyx.load_custom_mappings('my_mappings.json')
# View current mappings
print(twilnyx.MAPPINGS)
Example custom mappings file:
{
"parameter_mappings": {
"To": "destination",
"From": "source",
"Body": "message_content"
},
"texml_templates": {
"call": {
"element": "CustomDial",
"attributes": ["callerId"],
"children": [
{
"element": "Number",
"content": "destination"
}
]
}
}
}
Using All TwiML Verbs
The package includes a full mapping for all TwiML verbs and loads it by default. You can use any TwiML verb by specifying it in the 'verb' parameter:
import twilnyx
# Initialize Twilnyx - full mappings are loaded by default
twilnyx.use_telnyx(debug=True)
# Now you can use any TwiML verb by specifying it in the 'verb' parameter
from twilio.rest import Client
client = Client('TWILIO_ACCOUNT_SID', 'TWILIO_AUTH_TOKEN')
# Example: Gather DTMF input
call = client.calls.create(
to='+1234567890',
from_='+1987654321',
verb='gather', # Explicitly request Gather verb
finish_on_key='#',
num_digits=4,
prompt_text='Please enter your PIN'
)
See the examples/all_verbs_example.py file for examples of using all supported TwiML verbs, including:
<Connect>,<Dial>,<Enqueue>,<Gather>,<Hangup>,<Leave><Pause>,<Play>,<Record>,<Redirect>,<Refer><Reject>,<Say>,<Siprec>,<Stream>,<Transcription>
How It Works
-
Basic Flow:
Your Code -> Twilio SDK -> Twilnyx Proxy -> TeXML Response | v Parameter Mapping TeXML Generation -
Complete Flow:
+-------------+ +------------+ +-------------+ +-----------+ | Your Code | |Twilio SDK | |Twilnyx Proxy| | TeXML | | |--->| |--->| |--->| <Response>| +-------------+ +------------+ +-------------+ +-----------+ | v +---------------+ | Map Params | | Generate XML | +---------------+ -
TeXML Flow:
+-------------+ +------------+ +-------------+ +-----------+ | Your App | |Twilio SDK | |Twilnyx Proxy| | TeXML | |client.calls | | | | | | <Response>| | |--->| |--->| |--->| <Dial> | | | | | | | | <Number> | | | | | | | | <Play> | +-------------+ +------------+ +-------------+ +-----------+ -
SMS Flow with TeXML:
+-------------+ +------------+ +-------------+ +-----------+ | Your Code | |Twilio SDK | |Twilnyx Proxy| | TeXML | |client.msgs |--->| |--->| |--->| <Response>| +-------------+ +------------+ +-------------+ | <Say> | +-----------+ -
Parameter Mapping:
# Twilio format { 'To': '+1234567890', 'From': '+1987654321', 'Url': 'https://your-server.com/voice', 'MediaUrl': 'https://example.com/audio.mp3' # Media URL for TeXML } # Converted to Telnyx format { 'to': '+1234567890', 'from': '+1987654321', 'webhook_url': 'https://your-server.com/voice', 'voice_profile_id': 'your_profile_id', # Added automatically 'media_urls': 'https://example.com/audio.mp3' # Used for TeXML generation }
-
Response Conversion:
# Telnyx response { 'call_control_id': 'xyz', 'state': 'ringing' } # Converted to Twilio format { 'sid': 'xyz', 'status': 'ringing' }
Required Setup
-
No Telnyx API Credentials Required:
- This version uses TeXML exclusively
- No API keys or credentials needed
- Just import and use
-
TeXML Support:
- All requests are converted to TeXML responses
- Supports calls, messages, and media playback
- Compatible with Telnyx's XML format
-
Usage with Existing Code:
- Keep using your existing Twilio code
- No changes needed to your application logic
- Just add the
twilnyx.use_telnyx()call
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
- Complete TeXML support for all TwiML verbs:
<Connect>,<Dial>,<Enqueue>,<Gather>,<Hangup>,<Leave><Pause>,<Pay>,<Play>,<Record>,<Redirect>,<Refer><Reject>,<Say>,<Siprec>,<Stream>,<Transcription>
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT License
Metadata
Release files for twilnyx 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| twilnyx-0.3.0.tar.gz | 11.3 kB | Without provenance | Details for twilnyx-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| twilnyx-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for twilnyx-0.3.0-py3-none-any.whl |
Total release size: 21.8 kB
Release files / twilnyx-0.3.0.tar.gz
| Download URL | twilnyx-0.3.0.tar.gz |
|---|---|
| Size | 11.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
840fddcce62f7f90d08dbf17c43ee3da7a1bb939e6354cd7efaa12c441e0199e
|
|
BLAKE2b-256 checksum How to use checksums |
166a4451352273d2e4a9472afc9448d25d86de04d7013450125a07da1f6eb09e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Release files / twilnyx-0.3.0-py3-none-any.whl
| Download URL | twilnyx-0.3.0-py3-none-any.whl |
|---|---|
| Size | 10.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8731eb3ec8af93ac5f9e01a1ef1490786306ca37a74abc4bfb38fec1efb39c8e
|
|
BLAKE2b-256 checksum How to use checksums |
6339e6aa4c71d79a07738d98237f0d712b22637cea248e15a190b18921b9c9ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Security for twilnyx 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.