Introduction

Telcoflow SDK

View as Markdown

Python SDK for connecting to the Telcoflow Server, handling call events, managing media connections, and processing audio streams. These docs track the public telcoflow-sdk 0.24.0 package currently published on TestPyPI.

PyPI Python License

Features

  • Dual authentication - Support for API key authentication in SANDBOX mode and mTLS certificates in PROD mode
  • Automatic reconnection - Reconnects when the control connection drops
  • Event-driven call handling - Decorator-based handlers for call events plus async iterators for audio streams
  • Automatic media setup - Creates the media connection for you when a call arrives
  • Bidirectional audio streaming - Send and receive raw PCM audio over the media connection
  • Buffer management - Queue audio smoothly and clear pending playback on interruptions

The public 0.24.0 API is built around a small set of core patterns:

  1. Create a config with TelcoflowClientConfig.sandbox(...) or TelcoflowClientConfig.production(...)
  2. Start the client with async with TelcoflowClient(config) as client
  3. Register incoming-call handlers with @client.on(events.INCOMING_CALL)
  4. Work with each ActiveCall using methods like answer(), connect(), send_audio(), close(), and disconnect(), noting that close() behaves differently before and after connect()

Next Steps

  • Developer Onboarding - Gather the telco, phone number, WSS, firewall, and launch details needed before implementation
  • Installation - Install the SDK and pin the version these docs describe
  • Quick Start - Build a minimal 0.24.0 app
  • Architecture - Understand the control and media connection model