Document async SWML stream/stop_stream methods and the calling.call.stream webhook#361
Open
Devon-White wants to merge 2 commits into
Open
Document async SWML stream/stop_stream methods and the calling.call.stream webhook#361Devon-White wants to merge 2 commits into
Devon-White wants to merge 2 commits into
Conversation
…tream webhook SWML: - Add `stream` and `stop_stream` calling methods (TypeSpec models + reference pages with parameters, variables, and YAML/JSON examples) - Register both in the SWMLMethod union and the connect confirm allow-list - Add overview cards under Recording & taps Calling API / webhook: - Model the calling.call.stream status callback as an OpenAPI webhook (StreamStatusCallbackPayload) on the Calls namespace, registered under Calling > Webhooks; SWML page references it via WebhookPayloadSnippet - Payload shape validated against the mod_infrastructure C source (event_channel + params.segment_id always present; url required; name/tag optional) SDK: - Document the `streaming` state on the calling.call.stream event (Python + TS)
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
2 participants
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 async
stream/stop_streamSWML calling methods, which stream a call's audio to a WebSocket endpoint as a background operation (distinct from the bidirectionalstream:device type inconnect). Also formalizes the sharedcalling.call.streamstatus-callback as an OpenAPI webhook.SWML
streamandstop_streammethods — TypeSpec models (specs/swml/calling/Methods/{stream,stop_stream}) and customer-facing reference pages with parameters, variables, and YAML/JSON examples.SWMLMethodunion and theconnectconfirm allow-list (ValidConfirmMethods).Calling API / webhook
calling.call.streamstatus callback as an OpenAPI webhook (StreamStatusCallbackPayload) on the Calls namespace, registered under Calling → Webhooks. The SWML page references it via<WebhookPayloadSnippet>so the payload lives in one place (mirrors the transcribe pattern).calling.stream/calling.stream.stopREST command request payloads already existed onmain; no change needed there.SDK
streamingstate on thecalling.call.streamevent (Python + TypeScript) — previously onlyfinishedwas listed.Ground-truth validation
Method schemas and the event payload were validated against the FreeSWITCH
mod_infrastructureC source, not just the spec summary:stream'scodecis freeform (no enum/default) — unliketap's enum-constrained codec.event_channel(envelope) andparams.segment_idare always present (segment_id is backfilled to the session UUID);urlis required (a stream always has a destination); onlynameandtagare genuinely optional.Verification
tsp compile(calling-api + swml/calling) clean; OpenAPI regenerated.tsp format --checkpasses on new/edited specs.fern docs md check→ all MDX files valid.