Sha256: 8df92f390b90da18da1e312e2ec8698971867de0865b670b50e4f7d939ab1929

Contents?: true

Size: 1.71 KB

Versions: 14

Compression:

Stored size: 1.71 KB

Contents

# Bandwidth::TranscribeRecording

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **callback_url** | **String** | The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/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**](CallbackMethodEnum.md) |  | [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

```ruby
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
)
```

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
bandwidth-sdk-13.1.2 docs/TranscribeRecording.md
bandwidth-sdk-13.1.1 docs/TranscribeRecording.md
bandwidth-sdk-13.1.0 docs/TranscribeRecording.md
bandwidth-sdk-13.0.0 docs/TranscribeRecording.md
bandwidth-sdk-12.1.0 docs/TranscribeRecording.md
bandwidth-sdk-11.3.0 docs/TranscribeRecording.md
bandwidth-sdk-11.2.0 docs/TranscribeRecording.md
bandwidth-sdk-11.1.1 docs/TranscribeRecording.md
bandwidth-sdk-11.1.0 docs/TranscribeRecording.md
bandwidth-sdk-11.0.0 docs/TranscribeRecording.md
bandwidth-sdk-11.0.0.pre.beta.4.0 docs/TranscribeRecording.md
bandwidth-sdk-11.0.0.pre.beta.3.1 docs/TranscribeRecording.md
bandwidth-sdk-11.0.0.pre.beta.3.0 docs/TranscribeRecording.md
bandwidth-sdk-11.0.0.pre.beta.2.0 docs/TranscribeRecording.md