Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.71 KB

TranscribeRecording.md

File metadata and controls

30 lines (24 loc) · 1.71 KB
Raw

Bandwidth::TranscribeRecording

Properties

Name Type Description Notes
callback_url String The URL to send the TranscriptionAvailable event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization. [optional]
callback_method CallbackMethodEnum [optional][default to 'POST']
username String Basic auth username. [optional]
password String Basic auth password. [optional]
tag String (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. [optional]
callback_timeout Float This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25. [optional][default to 15]
detect_language Boolean A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. [optional][default to false]

Example

require 'bandwidth-sdk'

instance = Bandwidth::TranscribeRecording.new(
  callback_url: https://myServer.example/bandwidth/webhooks/transcriptionAvailable,
  callback_method: null,
  username: mySecretUsername,
  password: mySecretPassword1!,
  tag: exampleTag,
  callback_timeout: 5.5,
  detect_language: true
)