Repository navigation
Add a Telephony section to the README - #846
Open
maksym-t-didww wants to merge 1 commit into
Open
maksym-t-didww wants to merge 1 commit into
maksym-t-didww wants to merge 1 commit into
Conversation
The README covers TTS, voices, streaming, ElevenAgents and Speech Engine but says nothing about phone calls, even though conversational_ai.phone_numbers and conversational_ai.sip_trunk have been in the SDK for a while. Anyone wiring up a carrier has to reconstruct the flow from reference.md, which lists the models without conveying that inbound_trunk_config and outbound_trunk_config correspond to the two call directions, or that allowed_addresses and credentials are alternative authentication modes rather than both being required. The new section sits between ElevenAgents and Speech Engine and covers importing a number over SIP trunking, placing an outbound call, and listing configured numbers. Every example was checked against the generated models offline: the imports, the request-body construction, the create/outbound_call/list signatures, the response attributes each snippet prints, the documented transport and media_encryption values, and the claim that the same methods exist on AsyncElevenLabs. Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README documents TTS, voices, streaming, ElevenAgents and Speech Engine, but not telephony —
grep -i "twilio\|exotel\|sip\|phone" README.mdreturns nothing, even thoughconversational_ai.phone_numbersandconversational_ai.sip_trunkare both in the SDK.reference.mdlists the models, but it does not convey the two things that actually cost time when connecting a carrier:inbound_trunk_configandoutbound_trunk_configcorrespond to the two call directions, and you generally want both.allowed_addresses(ACL) andcredentials(digest) are alternative authentication modes, not two fields you have to fill in.What the section adds
It sits between
## ElevenAgentsand## Speech Engineand covers:phone_numbers.createwithPhoneNumbersCreateRequestBody_SipTrunk, both trunk configs, with comments marking which direction each one governs, plus the acceptedtransport/media_encryption/enabled_codecsvalues.sip_trunk.outbound_call.phone_numbers.list(provider="sip_trunk").AsyncElevenLabs.Verification
Every claim was checked against the generated models offline — no API calls, so nothing here needs a key:
providerresolves tosip_trunkcreate(request=...)inspect.signature→['request', 'request_options']outbound_call(agent_id, agent_phone_number_id, to_number)inspect.signaturelist(provider="sip_trunk")TelephonyProvider→twilio,sip_trunk,exotelphone_number.phone_number_idCreatePhoneNumberResponseModelcall.success,.conversation_id,.sip_call_idSipTrunkOutboundCallResponsenumber.phone_number_id,.label,.supports_outboundPhoneNumbersListResponseItem_SipTrunktransportacceptsauto/udp/tcp/tlsmedia_encryptionacceptsdisabled/allowed/requiredenabled_codecs=[...]AsyncElevenLabs"allowed_addressesonlyNotes
Happy to trim or restructure. One paragraph names carriers — Twilio, Telnyx, DIDWW and Vonage — purely to say that each documents its own hostnames, authentication mode and codecs; drop the names if you would rather the README not list providers.
Disclosure: I work at DIDWW, one of the carriers named there. The section is not about DIDWW and the SDK needs no DIDWW-specific code — any carrier connects through the generic
sip_trunkprovider, which is precisely the point the README was missing.Note
Low Risk
Documentation-only README change with no runtime or API behavior impact.
Overview
Adds a Telephony section to the README between ElevenAgents and Speech Engine, documenting conversational AI phone/SIP capabilities that were previously absent from the user-facing guide.
The section explains how Twilio/Exotel import differs from generic
sip_trunkcarriers, then walks throughphone_numbers.createwithPhoneNumbersCreateRequestBody_SipTrunk, separating inbound vs outbound trunk config and clarifying ACL (allowed_addresses) vs digest (credentials) as alternative auth modes. It documents acceptedtransport,media_encryption, and optionalenabled_codecs, links to the SIP trunking guide, and includes examples forsip_trunk.outbound_callandphone_numbers.list(provider="sip_trunk"), plus a note that the same APIs exist onAsyncElevenLabs.Reviewed by Cursor Bugbot for commit 0d481d6. Bugbot is set up for automated code reviews on this repo. Configure here.