From ceb72fec551d627a20e780e3a178cbe471b246f4 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 2 Jun 2026 14:27:41 +0000 Subject: [PATCH 1/2] fix: use method-specific Schema types for calling REST client pages Replace generic EndpointSchemaSnippet (which rendered all 35 command variants) with Fern's Schema component pointing to each method's specific type (e.g. Calling.CallPlayRequest for play, Calling.CallCreateRequest for dial). Also excludes the 'command' property since the SDK sets it automatically based on the method called. Affects both TypeScript and Python reference pages (74 files total). Co-Authored-By: bot_apk --- .../server-sdks/pages/reference/python/rest/calling/ai-hold.mdx | 2 +- .../pages/reference/python/rest/calling/ai-message.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/ai-stop.mdx | 2 +- .../pages/reference/python/rest/calling/ai-unhold.mdx | 2 +- .../python/rest/calling/collect-start-input-timers.mdx | 2 +- .../pages/reference/python/rest/calling/collect-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/collect.mdx | 2 +- .../pages/reference/python/rest/calling/denoise-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/denoise.mdx | 2 +- .../pages/reference/python/rest/calling/detect-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/detect.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/dial.mdx | 2 +- .../pages/reference/python/rest/calling/disconnect.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/end.mdx | 2 +- .../pages/reference/python/rest/calling/live-transcribe.mdx | 2 +- .../pages/reference/python/rest/calling/live-translate.mdx | 2 +- .../pages/reference/python/rest/calling/play-pause.mdx | 2 +- .../pages/reference/python/rest/calling/play-resume.mdx | 2 +- .../pages/reference/python/rest/calling/play-stop.mdx | 2 +- .../pages/reference/python/rest/calling/play-volume.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/play.mdx | 2 +- .../pages/reference/python/rest/calling/receive-fax-stop.mdx | 2 +- .../pages/reference/python/rest/calling/record-pause.mdx | 2 +- .../pages/reference/python/rest/calling/record-resume.mdx | 2 +- .../pages/reference/python/rest/calling/record-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/record.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/refer.mdx | 2 +- .../pages/reference/python/rest/calling/send-fax-stop.mdx | 2 +- .../pages/reference/python/rest/calling/stream-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/stream.mdx | 2 +- .../pages/reference/python/rest/calling/tap-stop.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/tap.mdx | 2 +- .../pages/reference/python/rest/calling/transcribe-stop.mdx | 2 +- .../pages/reference/python/rest/calling/transcribe.mdx | 2 +- .../pages/reference/python/rest/calling/transfer.mdx | 2 +- .../server-sdks/pages/reference/python/rest/calling/update.mdx | 2 +- .../pages/reference/python/rest/calling/user-event.mdx | 2 +- .../pages/reference/typescript/rest/calling/ai-hold.mdx | 2 +- .../pages/reference/typescript/rest/calling/ai-message.mdx | 2 +- .../pages/reference/typescript/rest/calling/ai-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/ai-unhold.mdx | 2 +- .../typescript/rest/calling/collect-start-input-timers.mdx | 2 +- .../pages/reference/typescript/rest/calling/collect-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/collect.mdx | 2 +- .../pages/reference/typescript/rest/calling/denoise-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/denoise.mdx | 2 +- .../pages/reference/typescript/rest/calling/detect-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/detect.mdx | 2 +- .../pages/reference/typescript/rest/calling/dial.mdx | 2 +- .../pages/reference/typescript/rest/calling/disconnect.mdx | 2 +- .../server-sdks/pages/reference/typescript/rest/calling/end.mdx | 2 +- .../pages/reference/typescript/rest/calling/live-transcribe.mdx | 2 +- .../pages/reference/typescript/rest/calling/live-translate.mdx | 2 +- .../pages/reference/typescript/rest/calling/play-pause.mdx | 2 +- .../pages/reference/typescript/rest/calling/play-resume.mdx | 2 +- .../pages/reference/typescript/rest/calling/play-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/play-volume.mdx | 2 +- .../pages/reference/typescript/rest/calling/play.mdx | 2 +- .../reference/typescript/rest/calling/receive-fax-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/record-pause.mdx | 2 +- .../pages/reference/typescript/rest/calling/record-resume.mdx | 2 +- .../pages/reference/typescript/rest/calling/record-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/record.mdx | 2 +- .../pages/reference/typescript/rest/calling/refer.mdx | 2 +- .../pages/reference/typescript/rest/calling/send-fax-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/stream-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/stream.mdx | 2 +- .../pages/reference/typescript/rest/calling/tap-stop.mdx | 2 +- .../server-sdks/pages/reference/typescript/rest/calling/tap.mdx | 2 +- .../pages/reference/typescript/rest/calling/transcribe-stop.mdx | 2 +- .../pages/reference/typescript/rest/calling/transcribe.mdx | 2 +- .../pages/reference/typescript/rest/calling/transfer.mdx | 2 +- .../pages/reference/typescript/rest/calling/update.mdx | 2 +- .../pages/reference/typescript/rest/calling/user-event.mdx | 2 +- 74 files changed, 74 insertions(+), 74 deletions(-) diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx index 4a01cd5bd5..722ffa736e 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx @@ -9,7 +9,7 @@ Put an active AI session on hold. The AI agent stops processing speech while the call remains connected. This is useful for transferring the caller to a human agent or performing background operations. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx index a8b658bab6..2b2b577fb0 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx @@ -9,7 +9,7 @@ Send a message to an active AI session on a call. This injects instructions or context into the AI agent's conversation without the caller hearing the message directly. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx index 6a569beafd..356d38c04d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Stop an active AI session on a call. The AI agent is disconnected but the call itself remains active, allowing further call control operations. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx index eb420693fd..690a7c8d2a 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx @@ -10,7 +10,7 @@ max-toc-depth: 3 Resume an AI session that was previously put on hold with [`ai_hold()`][ai-hold]. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx index dcfc73bba9..83a327940f 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx @@ -11,7 +11,7 @@ Manually start the input timers for a collection that was started without automatic timer activation. This is useful when you want to play a prompt before starting the timer countdown. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx index 8d47310bb2..78fee5bc5f 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active input collection. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx index b6d362f7bb..89b2bab73e 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start collecting user input on an active call. Supports DTMF digit collection and speech recognition. Returns a `control_id` for managing the collection. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx index 2ca3663a26..af6171dc0e 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx @@ -7,7 +7,7 @@ max-toc-depth: 3 Disable noise reduction on an active call. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx index 9f051195b9..57fdfeccbd 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Enable noise reduction on an active call. This applies real-time noise suppression to the audio stream, improving clarity for both parties. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx index 2674af731a..ca813d18d6 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active detector. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx index 657527f0fa..6e89696502 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start a detector on an active call. Detectors can identify answering machines, fax tones, or DTMF digits. Returns a `control_id` for managing the detector. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx index 2c5e097494..62473204e6 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx @@ -13,7 +13,7 @@ Since `from` is a Python reserved keyword, pass it as `from_=` or use dict unpacking: `**{"from": "+15551234567"}`. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx index 366378ccd7..2d77435967 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Disconnect (unbridge) a connected call. If two call legs are bridged together, this separates them without ending either leg. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx index a68023001f..4ccb52faa3 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx @@ -7,7 +7,7 @@ max-toc-depth: 3 End an active call. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx index 90c337e7f4..6c660a5f68 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx @@ -9,7 +9,7 @@ Start live transcription on an active call. Unlike standard transcription, live transcription streams partial results in real time as the caller speaks, enabling display of in-progress speech. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx index fdd36d268b..8793beb551 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start live translation on an active call. Spoken audio is transcribed and translated in real time to a target language. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx index b743e67755..4aa72e7923 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Pause an active playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx index 13e6549d98..51a5358e8e 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Resume a paused playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx index f0c60011b8..d92159dc87 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active playback immediately. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx index 08525a4732..2c01406ce7 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Adjust the volume of an active playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx index b4bb9603ef..ca6a54a091 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx @@ -17,7 +17,7 @@ used with [`play_pause()`][play-pause], [`play_volume()`][play-volume] to manage the playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx index da046649f5..0a38f58ebd 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx @@ -14,7 +14,7 @@ This method stops a fax receive that is already in progress. To initiate fax rec use the RELAY client's [`receive_fax()`][receive-fax] method. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx index a83890f9bf..78ebe634b3 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx @@ -11,7 +11,7 @@ max-toc-depth: 3 Pause an active recording. The recording can be resumed later with [`record_resume()`][record-resume]. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx index 84924abb7d..81067b6751 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Resume a paused recording. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx index ed477b531a..4ed0d869bd 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active recording. The recording file becomes available after stopping. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx index 9588185986..1a6fcf6a4e 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx @@ -14,7 +14,7 @@ Start recording an active call. Returns a `control_id` used to [resume][resume], or [stop][stop] the recording. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx index 0e282a36c6..9560387c39 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx @@ -17,7 +17,7 @@ SIP endpoint. SIP REFER is only applicable to SIP calls. It will not work on PSTN calls. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx index ee47dcb957..0aba1cf1fc 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx @@ -14,7 +14,7 @@ This method stops a fax send that is already in progress. To initiate fax sendin use the RELAY client's [`send_fax()`][send-fax] method. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx index cafcd75ee9..8e42d267d5 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active audio stream. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx index d855ebee4f..a789df9a3d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx @@ -9,7 +9,7 @@ Start streaming audio from an active call to a WebSocket endpoint. This is commonly used for real-time speech processing, analytics, or archival. Returns a `control_id` for stopping the stream. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx index f1a5eac191..eb997df7c7 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active audio tap. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx index 3f7a28af1d..15f4b87415 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx @@ -9,7 +9,7 @@ Start tapping audio from an active call and sending it to an external endpoint (e.g., a WebSocket or RTP destination). Returns a `control_id` for stopping the tap. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx index d0a840e388..33efb50bd8 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active transcription. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx index 9e3fc02d13..81b9f61d7d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start transcribing speech on an active call. Transcription results are delivered via events. Returns a `control_id` for stopping the transcription. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx index 088b821475..01d15ebcb1 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Transfer an active call to a new destination. The current call leg is replaced by a new connection to the specified target. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx index f5a12f6b0a..645208cd46 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx @@ -12,7 +12,7 @@ Unlike most calling methods, `update()` does **not** take a positional `call_id` parameter. Pass all fields (including call identification) as keyword arguments. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx index b5c09f443d..4f39b56fed 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx @@ -10,7 +10,7 @@ to pass arbitrary data between call control applications and event handlers. Listeners registered for user events on the RELAY side will receive the payload you send here. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx index 6fb9b713bc..beea83dd4c 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx @@ -9,7 +9,7 @@ Put an active AI session on hold. The AI agent stops processing speech while the call remains connected. This is useful for transferring the caller to a human agent or performing background operations. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx index d52ab64c3a..a34566f0e9 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx @@ -9,7 +9,7 @@ Send a message to an active AI session on a call. This injects instructions or context into the AI agent's conversation without the caller hearing the message directly. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx index 7dcf0d2459..01e6a46e9f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Stop an active AI session on a call. The AI agent is disconnected but the call itself remains active, allowing further call control operations. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx index 2c051207f1..f6513ebea9 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx @@ -10,7 +10,7 @@ max-toc-depth: 3 Resume an AI session that was previously put on hold with [`aiHold()`][ai-hold]. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx index b4ac5e536c..8ba26c21d7 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx @@ -11,7 +11,7 @@ Manually start the input timers for a collection that was started without automatic timer activation. This is useful when you want to play a prompt before starting the timer countdown. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx index 8a0034e88f..a470c75c6d 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active input collection. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx index 1d2aa85a71..e4e0ed0d94 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start collecting user input on an active call. Supports DTMF digit collection and speech recognition. Returns a `control_id` for managing the collection. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx index 7aa88645d5..2939d1ace5 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx @@ -7,7 +7,7 @@ max-toc-depth: 3 Disable noise reduction on an active call. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx index 022b66a517..9487b84f3c 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Enable noise reduction on an active call. This applies real-time noise suppression to the audio stream, improving clarity for both parties. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx index 561c625215..313dee12f6 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active detector. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx index 76622ec466..f740b5fc3f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start a detector on an active call. Detectors can identify answering machines, fax tones, or DTMF digits. Returns a `control_id` for managing the detector. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx index 763ccc5ecc..8ddcd9f5f6 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Initiate a new outbound call. Provide either a `url` pointing to a SWML document or an inline `swml` object to control the call flow. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx index 3d9594d9af..69f0932ff9 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Disconnect (unbridge) a connected call. If two call legs are bridged together, this separates them without ending either leg. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx index 96dca4872a..94817e90b2 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx @@ -7,7 +7,7 @@ max-toc-depth: 3 End an active call. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx index a754b2f212..b203a6f8b5 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx @@ -9,7 +9,7 @@ Start live transcription on an active call. Unlike standard transcription, live transcription streams partial results in real time as the caller speaks, enabling display of in-progress speech. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx index 43c0a758e4..ff1193edf0 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start live translation on an active call. Spoken audio is transcribed and translated in real time to a target language. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx index a932016082..6947cfd3f8 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Pause an active playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx index 9c47523372..b4149f0a20 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Resume a paused playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx index 0475a31a6d..a1b72590e1 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active playback immediately. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx index 3707877a31..b442a32c0f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Adjust the volume of an active playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx index 292ef2d93d..7146b3b885 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx @@ -17,7 +17,7 @@ used with [`playPause()`][play-pause], [`playVolume()`][play-volume] to manage the playback. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx index 4ecc9d2221..452fc4c79d 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx @@ -14,7 +14,7 @@ This method stops a fax receive that is already in progress. To initiate fax rec use the RELAY client's [`receiveFax()`][receive-fax] method. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx index b8dddf94e6..728e6ced9e 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx @@ -11,7 +11,7 @@ max-toc-depth: 3 Pause an active recording. The recording can be resumed later with [`recordResume()`][record-resume]. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx index b2c642bdb0..2edbd43755 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Resume a paused recording. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx index ea81bce895..a7233872ef 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active recording. The recording file becomes available after stopping. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx index f226151aad..f6f806a92f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx @@ -14,7 +14,7 @@ Start recording an active call. Returns a `control_id` used to [resume][resume], or [stop][stop] the recording. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx index 6bb2cfdccd..c91997d2a7 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx @@ -17,7 +17,7 @@ SIP endpoint. SIP REFER is only applicable to SIP calls. It will not work on PSTN calls. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx index 993db1ad3d..79059e9301 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx @@ -14,7 +14,7 @@ This method stops a fax send that is already in progress. To initiate fax sendin use the RELAY client's [`sendFax()`][send-fax] method. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx index a62c252f0d..b1a6000e3b 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active audio stream. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx index 767b64cfcf..42523b337b 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx @@ -9,7 +9,7 @@ Start streaming audio from an active call to a WebSocket endpoint. This is commonly used for real-time speech processing, analytics, or archival. Returns a `control_id` for stopping the stream. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx index 2c1462b571..9e451e332c 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active audio tap. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx index c1aa9755b5..efbeb2d69b 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx @@ -9,7 +9,7 @@ Start tapping audio from an active call and sending it to an external endpoint (e.g., a WebSocket or RTP destination). Returns a `control_id` for stopping the tap. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx index 5e3d2f1cd3..58f3c737d4 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx @@ -9,7 +9,7 @@ max-toc-depth: 3 Stop an active transcription. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx index a6c7074ad7..90dc1ecdeb 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Start transcribing speech on an active call. Transcription results are delivered via events. Returns a `control_id` for stopping the transcription. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx index 3283106dcd..499bab1e3b 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx @@ -8,7 +8,7 @@ max-toc-depth: 3 Transfer an active call to a new destination. The current call leg is replaced by a new connection to the specified target. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx index c87a592d4f..61a061fd86 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx @@ -12,7 +12,7 @@ Unlike most calling methods, `update()` does **not** take a positional `callId` parameter. Pass all fields (including call identification) in a single object. - + ## **Response Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx index 042ec4e274..827d13edd2 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx @@ -10,7 +10,7 @@ to pass arbitrary data between call control applications and event handlers. Listeners registered for user events on the RELAY side will receive the payload you send here. - + ## **Response Example** From 21e1d98855c5380c6155aedb85d59f7733effb1f Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 2 Jun 2026 14:42:28 +0000 Subject: [PATCH 2/2] add Request/Response headers and response Schema to calling pages - Add '## **Request**' header above the Schema component - Replace '## **Response Example**' with '## **Response**' - Replace EndpointResponseSnippet with Schema type='Calling.CallResponse' to show the structured response type definition Co-Authored-By: bot_apk --- .../pages/reference/python/rest/calling/ai-hold.mdx | 6 ++++-- .../pages/reference/python/rest/calling/ai-message.mdx | 6 ++++-- .../pages/reference/python/rest/calling/ai-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/ai-unhold.mdx | 6 ++++-- .../python/rest/calling/collect-start-input-timers.mdx | 6 ++++-- .../pages/reference/python/rest/calling/collect-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/collect.mdx | 6 ++++-- .../pages/reference/python/rest/calling/denoise-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/denoise.mdx | 6 ++++-- .../pages/reference/python/rest/calling/detect-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/detect.mdx | 6 ++++-- .../pages/reference/python/rest/calling/dial.mdx | 6 ++++-- .../pages/reference/python/rest/calling/disconnect.mdx | 6 ++++-- .../server-sdks/pages/reference/python/rest/calling/end.mdx | 6 ++++-- .../pages/reference/python/rest/calling/live-transcribe.mdx | 6 ++++-- .../pages/reference/python/rest/calling/live-translate.mdx | 6 ++++-- .../pages/reference/python/rest/calling/play-pause.mdx | 6 ++++-- .../pages/reference/python/rest/calling/play-resume.mdx | 6 ++++-- .../pages/reference/python/rest/calling/play-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/play-volume.mdx | 6 ++++-- .../pages/reference/python/rest/calling/play.mdx | 6 ++++-- .../reference/python/rest/calling/receive-fax-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/record-pause.mdx | 6 ++++-- .../pages/reference/python/rest/calling/record-resume.mdx | 6 ++++-- .../pages/reference/python/rest/calling/record-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/record.mdx | 6 ++++-- .../pages/reference/python/rest/calling/refer.mdx | 6 ++++-- .../pages/reference/python/rest/calling/send-fax-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/stream-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/stream.mdx | 6 ++++-- .../pages/reference/python/rest/calling/tap-stop.mdx | 6 ++++-- .../server-sdks/pages/reference/python/rest/calling/tap.mdx | 6 ++++-- .../pages/reference/python/rest/calling/transcribe-stop.mdx | 6 ++++-- .../pages/reference/python/rest/calling/transcribe.mdx | 6 ++++-- .../pages/reference/python/rest/calling/transfer.mdx | 6 ++++-- .../pages/reference/python/rest/calling/update.mdx | 6 ++++-- .../pages/reference/python/rest/calling/user-event.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/ai-hold.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/ai-message.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/ai-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/ai-unhold.mdx | 6 ++++-- .../typescript/rest/calling/collect-start-input-timers.mdx | 6 ++++-- .../reference/typescript/rest/calling/collect-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/collect.mdx | 6 ++++-- .../reference/typescript/rest/calling/denoise-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/denoise.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/detect-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/detect.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/dial.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/disconnect.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/end.mdx | 6 ++++-- .../reference/typescript/rest/calling/live-transcribe.mdx | 6 ++++-- .../reference/typescript/rest/calling/live-translate.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/play-pause.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/play-resume.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/play-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/play-volume.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/play.mdx | 6 ++++-- .../reference/typescript/rest/calling/receive-fax-stop.mdx | 6 ++++-- .../reference/typescript/rest/calling/record-pause.mdx | 6 ++++-- .../reference/typescript/rest/calling/record-resume.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/record-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/record.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/refer.mdx | 6 ++++-- .../reference/typescript/rest/calling/send-fax-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/stream-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/stream.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/tap-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/tap.mdx | 6 ++++-- .../reference/typescript/rest/calling/transcribe-stop.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/transcribe.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/transfer.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/update.mdx | 6 ++++-- .../pages/reference/typescript/rest/calling/user-event.mdx | 6 ++++-- 74 files changed, 296 insertions(+), 148 deletions(-) diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx index 722ffa736e..cbc537761d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx @@ -9,11 +9,13 @@ Put an active AI session on hold. The AI agent stops processing speech while the call remains connected. This is useful for transferring the caller to a human agent or performing background operations. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx index 2b2b577fb0..6ad6706562 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx @@ -9,11 +9,13 @@ Send a message to an active AI session on a call. This injects instructions or context into the AI agent's conversation without the caller hearing the message directly. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx index 356d38c04d..771d8a8113 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Stop an active AI session on a call. The AI agent is disconnected but the call itself remains active, allowing further call control operations. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx index 690a7c8d2a..52fc0f034f 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx @@ -10,11 +10,13 @@ max-toc-depth: 3 Resume an AI session that was previously put on hold with [`ai_hold()`][ai-hold]. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx index 83a327940f..36d5bdc4fc 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx @@ -11,11 +11,13 @@ Manually start the input timers for a collection that was started without automatic timer activation. This is useful when you want to play a prompt before starting the timer countdown. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx index 78fee5bc5f..e3259e806a 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active input collection. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx index 89b2bab73e..ebaaed55c1 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start collecting user input on an active call. Supports DTMF digit collection and speech recognition. Returns a `control_id` for managing the collection. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx index af6171dc0e..0e3b043de3 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx @@ -7,11 +7,13 @@ max-toc-depth: 3 Disable noise reduction on an active call. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx index 57fdfeccbd..d1a7111759 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Enable noise reduction on an active call. This applies real-time noise suppression to the audio stream, improving clarity for both parties. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx index ca813d18d6..a54dcaa3f1 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active detector. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx index 6e89696502..0bf9ba555b 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/detect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start a detector on an active call. Detectors can identify answering machines, fax tones, or DTMF digits. Returns a `control_id` for managing the detector. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx index 62473204e6..05106f525f 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/dial.mdx @@ -13,11 +13,13 @@ Since `from` is a Python reserved keyword, pass it as `from_=` or use dict unpacking: `**{"from": "+15551234567"}`. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx index 2d77435967..4cbc01dfb5 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/disconnect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Disconnect (unbridge) a connected call. If two call legs are bridged together, this separates them without ending either leg. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx index 4ccb52faa3..4cfc0dd0c5 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/end.mdx @@ -7,11 +7,13 @@ max-toc-depth: 3 End an active call. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx index 6c660a5f68..24986a6ecc 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/live-transcribe.mdx @@ -9,11 +9,13 @@ Start live transcription on an active call. Unlike standard transcription, live transcription streams partial results in real time as the caller speaks, enabling display of in-progress speech. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx index 8793beb551..bc129472ad 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/live-translate.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start live translation on an active call. Spoken audio is transcribed and translated in real time to a target language. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx index 4aa72e7923..ad9ff71002 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-pause.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Pause an active playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx index 51a5358e8e..f671638c0f 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-resume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Resume a paused playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx index d92159dc87..8471324b4d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active playback immediately. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx index 2c01406ce7..1607cf1077 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play-volume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Adjust the volume of an active playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx index ca6a54a091..2c3771d5e2 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/play.mdx @@ -17,11 +17,13 @@ used with [`play_pause()`][play-pause], [`play_volume()`][play-volume] to manage the playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx index 0a38f58ebd..681a0c479a 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/receive-fax-stop.mdx @@ -14,11 +14,13 @@ This method stops a fax receive that is already in progress. To initiate fax rec use the RELAY client's [`receive_fax()`][receive-fax] method. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx index 78ebe634b3..ece4241b61 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-pause.mdx @@ -11,11 +11,13 @@ max-toc-depth: 3 Pause an active recording. The recording can be resumed later with [`record_resume()`][record-resume]. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx index 81067b6751..6ea53c4a4b 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-resume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Resume a paused recording. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx index 4ed0d869bd..9a38a97fe2 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active recording. The recording file becomes available after stopping. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx index 1a6fcf6a4e..91261f0c25 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/record.mdx @@ -14,11 +14,13 @@ Start recording an active call. Returns a `control_id` used to [resume][resume], or [stop][stop] the recording. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx index 9560387c39..072ddc3884 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/refer.mdx @@ -17,11 +17,13 @@ SIP endpoint. SIP REFER is only applicable to SIP calls. It will not work on PSTN calls. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx index 0aba1cf1fc..5f2cdf4034 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/send-fax-stop.mdx @@ -14,11 +14,13 @@ This method stops a fax send that is already in progress. To initiate fax sendin use the RELAY client's [`send_fax()`][send-fax] method. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx index 8e42d267d5..b93c57b455 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/stream-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active audio stream. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx index a789df9a3d..5f069d2379 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/stream.mdx @@ -9,11 +9,13 @@ Start streaming audio from an active call to a WebSocket endpoint. This is commonly used for real-time speech processing, analytics, or archival. Returns a `control_id` for stopping the stream. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx index eb997df7c7..ed3706d2e8 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/tap-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active audio tap. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx index 15f4b87415..c5228502b1 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/tap.mdx @@ -9,11 +9,13 @@ Start tapping audio from an active call and sending it to an external endpoint (e.g., a WebSocket or RTP destination). Returns a `control_id` for stopping the tap. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx index 33efb50bd8..5d3d1d049d 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active transcription. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx index 81b9f61d7d..a3a6b737e2 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transcribe.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start transcribing speech on an active call. Transcription results are delivered via events. Returns a `control_id` for stopping the transcription. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx index 01d15ebcb1..fe15cf60e6 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/transfer.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Transfer an active call to a new destination. The current call leg is replaced by a new connection to the specified target. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx index 645208cd46..3e1c054501 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/update.mdx @@ -12,11 +12,13 @@ Unlike most calling methods, `update()` does **not** take a positional `call_id` parameter. Pass all fields (including call identification) as keyword arguments. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx b/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx index 4f39b56fed..b9c49b19df 100644 --- a/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx +++ b/fern/products/server-sdks/pages/reference/python/rest/calling/user-event.mdx @@ -10,11 +10,13 @@ to pass arbitrary data between call control applications and event handlers. Listeners registered for user events on the RELAY side will receive the payload you send here. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx index beea83dd4c..8ad55622d4 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-hold.mdx @@ -9,11 +9,13 @@ Put an active AI session on hold. The AI agent stops processing speech while the call remains connected. This is useful for transferring the caller to a human agent or performing background operations. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx index a34566f0e9..a5e764fd7f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-message.mdx @@ -9,11 +9,13 @@ Send a message to an active AI session on a call. This injects instructions or context into the AI agent's conversation without the caller hearing the message directly. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx index 01e6a46e9f..f36768c7da 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-stop.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Stop an active AI session on a call. The AI agent is disconnected but the call itself remains active, allowing further call control operations. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx index f6513ebea9..e2ad9e7f98 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/ai-unhold.mdx @@ -10,11 +10,13 @@ max-toc-depth: 3 Resume an AI session that was previously put on hold with [`aiHold()`][ai-hold]. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx index 8ba26c21d7..16424e21e8 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-start-input-timers.mdx @@ -11,11 +11,13 @@ Manually start the input timers for a collection that was started without automatic timer activation. This is useful when you want to play a prompt before starting the timer countdown. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx index a470c75c6d..15f6af450a 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active input collection. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx index e4e0ed0d94..56da07befb 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/collect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start collecting user input on an active call. Supports DTMF digit collection and speech recognition. Returns a `control_id` for managing the collection. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx index 2939d1ace5..3859834469 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise-stop.mdx @@ -7,11 +7,13 @@ max-toc-depth: 3 Disable noise reduction on an active call. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx index 9487b84f3c..0af21a77ec 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/denoise.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Enable noise reduction on an active call. This applies real-time noise suppression to the audio stream, improving clarity for both parties. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx index 313dee12f6..df8291fc88 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active detector. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx index f740b5fc3f..da041665ce 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/detect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start a detector on an active call. Detectors can identify answering machines, fax tones, or DTMF digits. Returns a `control_id` for managing the detector. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx index 8ddcd9f5f6..4c11388e90 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/dial.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Initiate a new outbound call. Provide either a `url` pointing to a SWML document or an inline `swml` object to control the call flow. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx index 69f0932ff9..7ba7491bf8 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/disconnect.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Disconnect (unbridge) a connected call. If two call legs are bridged together, this separates them without ending either leg. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx index 94817e90b2..be2beaf850 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/end.mdx @@ -7,11 +7,13 @@ max-toc-depth: 3 End an active call. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx index b203a6f8b5..cc50338ba5 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-transcribe.mdx @@ -9,11 +9,13 @@ Start live transcription on an active call. Unlike standard transcription, live transcription streams partial results in real time as the caller speaks, enabling display of in-progress speech. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx index ff1193edf0..dc1180e8d2 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/live-translate.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start live translation on an active call. Spoken audio is transcribed and translated in real time to a target language. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx index 6947cfd3f8..854065e126 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-pause.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Pause an active playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx index b4149f0a20..a7fd0c0a53 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-resume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Resume a paused playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx index a1b72590e1..8e7bd80f4f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active playback immediately. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx index b442a32c0f..790e3e4c53 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play-volume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Adjust the volume of an active playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx index 7146b3b885..f2f9a1c31e 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/play.mdx @@ -17,11 +17,13 @@ used with [`playPause()`][play-pause], [`playVolume()`][play-volume] to manage the playback. +## **Request** + -## **Response Example** +## **Response** - + ## **Examples** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx index 452fc4c79d..32c095ed62 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/receive-fax-stop.mdx @@ -14,11 +14,13 @@ This method stops a fax receive that is already in progress. To initiate fax rec use the RELAY client's [`receiveFax()`][receive-fax] method. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx index 728e6ced9e..9818e2f5ba 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-pause.mdx @@ -11,11 +11,13 @@ max-toc-depth: 3 Pause an active recording. The recording can be resumed later with [`recordResume()`][record-resume]. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx index 2edbd43755..5d8c07075f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-resume.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Resume a paused recording. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx index a7233872ef..63b1724781 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active recording. The recording file becomes available after stopping. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx index f6f806a92f..f8c0b59d82 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/record.mdx @@ -14,11 +14,13 @@ Start recording an active call. Returns a `control_id` used to [resume][resume], or [stop][stop] the recording. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx index c91997d2a7..1061f1e5e4 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/refer.mdx @@ -17,11 +17,13 @@ SIP endpoint. SIP REFER is only applicable to SIP calls. It will not work on PSTN calls. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx index 79059e9301..921be14055 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/send-fax-stop.mdx @@ -14,11 +14,13 @@ This method stops a fax send that is already in progress. To initiate fax sendin use the RELAY client's [`sendFax()`][send-fax] method. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx index b1a6000e3b..3f17cff3e6 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active audio stream. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx index 42523b337b..5c11fe36de 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/stream.mdx @@ -9,11 +9,13 @@ Start streaming audio from an active call to a WebSocket endpoint. This is commonly used for real-time speech processing, analytics, or archival. Returns a `control_id` for stopping the stream. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx index 9e451e332c..7dbb23aefd 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active audio tap. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx index efbeb2d69b..f735947d75 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/tap.mdx @@ -9,11 +9,13 @@ Start tapping audio from an active call and sending it to an external endpoint (e.g., a WebSocket or RTP destination). Returns a `control_id` for stopping the tap. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx index 58f3c737d4..d18604d841 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe-stop.mdx @@ -9,11 +9,13 @@ max-toc-depth: 3 Stop an active transcription. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx index 90dc1ecdeb..d8eb51ec62 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transcribe.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Start transcribing speech on an active call. Transcription results are delivered via events. Returns a `control_id` for stopping the transcription. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx index 499bab1e3b..7bbeeec07b 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/transfer.mdx @@ -8,11 +8,13 @@ max-toc-depth: 3 Transfer an active call to a new destination. The current call leg is replaced by a new connection to the specified target. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx index 61a061fd86..79621977c8 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/update.mdx @@ -12,11 +12,13 @@ Unlike most calling methods, `update()` does **not** take a positional `callId` parameter. Pass all fields (including call identification) in a single object. +## **Request** + -## **Response Example** +## **Response** - + ## **Example** diff --git a/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx b/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx index 827d13edd2..a461e8497f 100644 --- a/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx +++ b/fern/products/server-sdks/pages/reference/typescript/rest/calling/user-event.mdx @@ -10,11 +10,13 @@ to pass arbitrary data between call control applications and event handlers. Listeners registered for user events on the RELAY side will receive the payload you send here. +## **Request** + -## **Response Example** +## **Response** - + ## **Example**