Stop Transcription

The StopTranscription verb is used to stop a real-time transcription that was started with a previous <StartTranscription> verb.

If there is no real-time transcription with the given name active on the call, this verb has no effect. If no name is specified, all active call transcriptions (does not include transcribed recordings) are stopped.

Text Content

There is no text content available to be set for the <StopTranscription> verb.

Attributes

Attribute	Description
name	(optional) The name of the real-time transcription to stop. This is either the user selected name when sending the <StartTranscription> verb, or the system generated name returned in the Real-Time Transcription Started webhook if <StartTranscription> was sent with no name attribute. If no name is specified, then all active call transcriptions will be stopped.

Webhooks Received

Webhooks	Can reply with more BXML
Real-Time Transcription Stopped	No
Real-Time Transcription Available	No

Examples

Stop an Active Transcription

XML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <StopTranscription name="live_audience"/>
</Response>

Ruby

stop_transcription = Bandwidth::Bxml::StopTranscription.new({ name: 'live_audience' })
response = Bandwidth::Bxml::Response.new([stop_transcription])

p response.to_bxml

NodeJS

const stopTranscription = new Bxml.StopTranscription({
    name: 'live_audience'
});
const response = new Bxml.Response(stopTranscription);

console.log(response.toBxml());

Python

stop_transcription = StopTranscription(name='live_audience')
response = Response(nested_verbs=[stop_transcription])

print(response.to_bxml())