Add stream parameter to join_conference (SWML, REST, SDKs)#364
Open
Devon-White wants to merge 1 commit into
Open
Add stream parameter to join_conference (SWML, REST, SDKs)#364Devon-White wants to merge 1 commit into
Devon-White wants to merge 1 commit into
Conversation
Document the new optional `stream` object on `join_conference`, which attaches a bidirectional WebSocket stream to a conference (real-time audio processing, transcription, AI agents). Verified against backend source (FreeSWITCH mod_infrastructure call_device_stream schema; Rails /calls dispatch). - SWML: add `stream` object to join_conference (TypeSpec + MDX) with a YAML/JSON example. - Calling REST API: add new `calling.join_conference` command with the nested stream object (modeled on call_join_conference + the calling.stream schema). - Server SDK reference (Python + TypeScript): expand the one-line stream stub into full sub-parameters and update examples. Also correct pre-existing source mismatches in the same method: - status_callback_event / recording_status_callback_event are space-separated strings, not single enums. - SWML `region` is the enum global|us|eu|ch (was a free string with an invalid "us-east" example). - Add the missing status_callback_event_type / recording_status_callback_event_type fields to the SWML spec/MDX.
Contributor
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
1 participant
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.
Summary
Documents the new optional
streamobject onjoin_conference, which attaches a bidirectional WebSocket stream directly to a conference — enabling real-time conference audio processing, transcription bots, and AI agents that listen to conference audio. The stream reuses the samecall_device_streamschema as thestreamdevice type inconnect.Changes
SWML
join_conference(specs/swml/.../join_conference/main.tsp+ MDX)streamobject (urlrequired wss,name,codec,status_url,status_url_method,realtime,authorization_bearer_token,custom_parameters) with a YAML/JSON example.Calling REST API (
specs/signalwire-rest/calling-api/...)calling.join_conferencecommand (CallJoinConferenceRequest+ConferenceStreamParams), union entry, example, and command-table row. Renders in the auto-generated/callsAPI reference.Server SDK reference (Python + TypeScript
relay/call/join-conference.mdx)stream/stream_objstub into full sub-parameters and update the examples. (Verified the real param names against SDK source: Pythonstream_obj, TSstream— inner keys are snake_case, passed through verbatim.)Correctness fixes to pre-existing fields (same method)
Surfaced during a source audit:
status_callback_event/recording_status_callback_eventare space-separated strings (each token validated), not single enums.regionis the enumglobal|us|eu|ch— it was modeled as a free string with an invalid"us-east"example.status_callback_event_type/recording_status_callback_event_typefields to the SWML spec/MDX (already present in REST + SDK).Notes
FunctionResult.join_conferencebuilder does not expose astreamparam in SDK source, so its docs are intentionally left unchanged.openapi.yaml,SWMLObject.json) regenerated viatsp compile; both specs build clean.