bandwidth-sdk 11.2.0 → 12.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +29 -25
- data/README.md +14 -8
- data/bandwidth.yml +223 -17
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +612 -209
- data/coverage/index.html +14875 -10424
- data/custom_templates/README.mustache +4 -4
- data/docs/CallRecordingMetadata.md +1 -1
- data/docs/CallTranscription.md +24 -0
- data/docs/CallTranscriptionMetadata.md +20 -0
- data/docs/CallTranscriptionResponse.md +24 -0
- data/docs/RecordingAvailableCallback.md +2 -2
- data/docs/RecordingTranscriptionMetadata.md +24 -0
- data/docs/RecordingTranscriptions.md +18 -0
- data/docs/RecordingsApi.md +49 -49
- data/docs/TranscriptionsApi.md +229 -0
- data/lib/bandwidth-sdk/api/recordings_api.rb +56 -56
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +241 -0
- data/lib/bandwidth-sdk/configuration.rb +22 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +2 -1
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription.rb +317 -0
- data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +223 -0
- data/lib/bandwidth-sdk/models/call_transcription_response.rb +244 -0
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/recording_transcription_metadata.rb +244 -0
- data/lib/bandwidth-sdk/models/recording_transcriptions.rb +214 -0
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +6 -2
- data/spec/api/calls_api_spec.rb +4 -4
- data/spec/api/conferences_api_spec.rb +12 -12
- data/spec/api/media_api_spec.rb +6 -6
- data/spec/api/messages_api_spec.rb +2 -2
- data/spec/api/mfa_api_spec.rb +6 -6
- data/spec/api/phone_number_lookup_api_spec.rb +2 -2
- data/spec/api/recordings_api_spec.rb +30 -30
- data/spec/api/statistics_api_spec.rb +1 -1
- data/spec/api/transcriptions_api_spec.rb +130 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/integration/calls_api_integration_spec.rb +7 -7
- data/spec/integration/conferences_api_integration_spec.rb +9 -9
- data/spec/integration/media_api_integration_spec.rb +7 -7
- data/spec/integration/messages_api_integration_spec.rb +3 -3
- data/spec/integration/mfa_api_integration_spec.rb +3 -3
- data/spec/integration/phone_number_lookup_api_integration_spec.rb +2 -2
- data/spec/integration/recordings_api_integration_spec.rb +14 -14
- data/spec/integration/statistics_api_integration_spec.rb +1 -1
- data/spec/integration/transcriptions_api_integration_spec.rb +84 -0
- data/spec/models/bxml/verbs/transfer_spec.rb +7 -5
- data/spec/spec_helper.rb +1 -1
- metadata +50 -34
@@ -7,10 +7,10 @@
|
|
7
7
|
|
8
8
|
| **OS** | **Ruby** |
|
9
9
|
|:---:|:---:|
|
10
|
-
| Windows 2019 | 2.7, 3.0, 3.1, 3.2 |
|
11
|
-
| Windows 2022 | 2.7, 3.0, 3.1, 3.2 |
|
12
|
-
| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2 |
|
13
|
-
| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2 |
|
10
|
+
| Windows 2019 | 2.7, 3.0, 3.1, 3.2, 3.3 |
|
11
|
+
| Windows 2022 | 2.7, 3.0, 3.1, 3.2, 3.3 |
|
12
|
+
| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
|
13
|
+
| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
|
14
14
|
|
15
15
|
{{moduleName}} - the Ruby gem for the {{appName}} SDK
|
16
16
|
|
@@ -21,7 +21,7 @@
|
|
21
21
|
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
22
22
|
| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
23
23
|
| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
|
24
|
-
| **transcription** | [**
|
24
|
+
| **transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] |
|
25
25
|
|
26
26
|
## Example
|
27
27
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Bandwidth::CallTranscription
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **detected_language** | **String** | The detected language for this transcription. | [optional] |
|
8
|
+
| **track** | **String** | Which `track` this transcription is derived from. | [optional] |
|
9
|
+
| **text** | **String** | The transcription itself. | [optional] |
|
10
|
+
| **confidence** | **Float** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'bandwidth-sdk'
|
16
|
+
|
17
|
+
instance = Bandwidth::CallTranscription.new(
|
18
|
+
detected_language: en-US,
|
19
|
+
track: inbound,
|
20
|
+
text: Hello World! This is an example.,
|
21
|
+
confidence: 0.9
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Bandwidth::CallTranscriptionMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
|
8
|
+
| **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'bandwidth-sdk'
|
14
|
+
|
15
|
+
instance = Bandwidth::CallTranscriptionMetadata.new(
|
16
|
+
transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
|
17
|
+
transcription_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Bandwidth::CallTranscriptionResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
8
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
9
|
+
| **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
|
10
|
+
| **tracks** | [**Array<CallTranscription>**](CallTranscription.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'bandwidth-sdk'
|
16
|
+
|
17
|
+
instance = Bandwidth::CallTranscriptionResponse.new(
|
18
|
+
account_id: 920012,
|
19
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
20
|
+
transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
|
21
|
+
tracks: [{"detectedLanguage":"en-US","track":"inbound","text":"Hello World! This is an example.","confidence":0.9}]
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -21,7 +21,7 @@
|
|
21
21
|
| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
|
22
22
|
| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
|
23
23
|
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
24
|
-
| **channels** | **
|
24
|
+
| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
|
25
25
|
| **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] |
|
26
26
|
| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
27
27
|
| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
|
@@ -50,7 +50,7 @@ instance = Bandwidth::RecordingAvailableCallback.new(
|
|
50
50
|
end_time: 2022-06-17T22:20Z,
|
51
51
|
duration: PT13.67S,
|
52
52
|
file_format: null,
|
53
|
-
channels:
|
53
|
+
channels: 1,
|
54
54
|
tag: exampleTag,
|
55
55
|
status: completed,
|
56
56
|
transfer_caller_id: +15555555555,
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Bandwidth::RecordingTranscriptionMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The unique transcription ID | [optional] |
|
8
|
+
| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
9
|
+
| **completed_time** | **String** | The time that the transcription was completed | [optional] |
|
10
|
+
| **url** | **String** | The URL of the [transcription](#operation/getCallTranscription) | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'bandwidth-sdk'
|
16
|
+
|
17
|
+
instance = Bandwidth::RecordingTranscriptionMetadata.new(
|
18
|
+
id: t-387bd648-18f3-4823-9d16-746bca0003c9,
|
19
|
+
status: completed,
|
20
|
+
completed_time: 2022-06-13T18:46:29.715Z,
|
21
|
+
url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Bandwidth::RecordingTranscriptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **transcripts** | [**Array<Transcription>**](Transcription.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'bandwidth-sdk'
|
13
|
+
|
14
|
+
instance = Bandwidth::RecordingTranscriptions.new(
|
15
|
+
transcripts: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/RecordingsApi.md
CHANGED
@@ -4,25 +4,25 @@ All URIs are relative to *http://localhost*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**delete_call_transcription**](RecordingsApi.md#delete_call_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription |
|
8
7
|
| [**delete_recording**](RecordingsApi.md#delete_recording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording |
|
9
8
|
| [**delete_recording_media**](RecordingsApi.md#delete_recording_media) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media |
|
9
|
+
| [**delete_recording_transcription**](RecordingsApi.md#delete_recording_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription |
|
10
10
|
| [**download_call_recording**](RecordingsApi.md#download_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording |
|
11
11
|
| [**get_call_recording**](RecordingsApi.md#get_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording |
|
12
|
-
| [**
|
12
|
+
| [**get_recording_transcription**](RecordingsApi.md#get_recording_transcription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription |
|
13
13
|
| [**list_account_call_recordings**](RecordingsApi.md#list_account_call_recordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings |
|
14
14
|
| [**list_call_recordings**](RecordingsApi.md#list_call_recordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings |
|
15
15
|
| [**transcribe_call_recording**](RecordingsApi.md#transcribe_call_recording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request |
|
16
16
|
| [**update_call_recording_state**](RecordingsApi.md#update_call_recording_state) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording |
|
17
17
|
|
18
18
|
|
19
|
-
##
|
19
|
+
## delete_recording
|
20
20
|
|
21
|
-
>
|
21
|
+
> delete_recording(account_id, call_id, recording_id)
|
22
22
|
|
23
|
-
Delete
|
23
|
+
Delete Recording
|
24
24
|
|
25
|
-
|
25
|
+
Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
26
26
|
|
27
27
|
### Examples
|
28
28
|
|
@@ -42,28 +42,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
|
|
42
42
|
recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
|
43
43
|
|
44
44
|
begin
|
45
|
-
# Delete
|
46
|
-
api_instance.
|
45
|
+
# Delete Recording
|
46
|
+
api_instance.delete_recording(account_id, call_id, recording_id)
|
47
47
|
rescue Bandwidth::ApiError => e
|
48
|
-
puts "Error when calling RecordingsApi->
|
48
|
+
puts "Error when calling RecordingsApi->delete_recording: #{e}"
|
49
49
|
end
|
50
50
|
```
|
51
51
|
|
52
|
-
#### Using the
|
52
|
+
#### Using the delete_recording_with_http_info variant
|
53
53
|
|
54
54
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
55
55
|
|
56
|
-
> <Array(nil, Integer, Hash)>
|
56
|
+
> <Array(nil, Integer, Hash)> delete_recording_with_http_info(account_id, call_id, recording_id)
|
57
57
|
|
58
58
|
```ruby
|
59
59
|
begin
|
60
|
-
# Delete
|
61
|
-
data, status_code, headers = api_instance.
|
60
|
+
# Delete Recording
|
61
|
+
data, status_code, headers = api_instance.delete_recording_with_http_info(account_id, call_id, recording_id)
|
62
62
|
p status_code # => 2xx
|
63
63
|
p headers # => { ... }
|
64
64
|
p data # => nil
|
65
65
|
rescue Bandwidth::ApiError => e
|
66
|
-
puts "Error when calling RecordingsApi->
|
66
|
+
puts "Error when calling RecordingsApi->delete_recording_with_http_info: #{e}"
|
67
67
|
end
|
68
68
|
```
|
69
69
|
|
@@ -89,13 +89,13 @@ nil (empty response body)
|
|
89
89
|
- **Accept**: application/json
|
90
90
|
|
91
91
|
|
92
|
-
##
|
92
|
+
## delete_recording_media
|
93
93
|
|
94
|
-
>
|
94
|
+
> delete_recording_media(account_id, call_id, recording_id)
|
95
95
|
|
96
|
-
Delete Recording
|
96
|
+
Delete Recording Media
|
97
97
|
|
98
|
-
|
98
|
+
Deletes the specified recording's media.
|
99
99
|
|
100
100
|
### Examples
|
101
101
|
|
@@ -115,28 +115,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
|
|
115
115
|
recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
|
116
116
|
|
117
117
|
begin
|
118
|
-
# Delete Recording
|
119
|
-
api_instance.
|
118
|
+
# Delete Recording Media
|
119
|
+
api_instance.delete_recording_media(account_id, call_id, recording_id)
|
120
120
|
rescue Bandwidth::ApiError => e
|
121
|
-
puts "Error when calling RecordingsApi->
|
121
|
+
puts "Error when calling RecordingsApi->delete_recording_media: #{e}"
|
122
122
|
end
|
123
123
|
```
|
124
124
|
|
125
|
-
#### Using the
|
125
|
+
#### Using the delete_recording_media_with_http_info variant
|
126
126
|
|
127
127
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
128
128
|
|
129
|
-
> <Array(nil, Integer, Hash)>
|
129
|
+
> <Array(nil, Integer, Hash)> delete_recording_media_with_http_info(account_id, call_id, recording_id)
|
130
130
|
|
131
131
|
```ruby
|
132
132
|
begin
|
133
|
-
# Delete Recording
|
134
|
-
data, status_code, headers = api_instance.
|
133
|
+
# Delete Recording Media
|
134
|
+
data, status_code, headers = api_instance.delete_recording_media_with_http_info(account_id, call_id, recording_id)
|
135
135
|
p status_code # => 2xx
|
136
136
|
p headers # => { ... }
|
137
137
|
p data # => nil
|
138
138
|
rescue Bandwidth::ApiError => e
|
139
|
-
puts "Error when calling RecordingsApi->
|
139
|
+
puts "Error when calling RecordingsApi->delete_recording_media_with_http_info: #{e}"
|
140
140
|
end
|
141
141
|
```
|
142
142
|
|
@@ -162,13 +162,13 @@ nil (empty response body)
|
|
162
162
|
- **Accept**: application/json
|
163
163
|
|
164
164
|
|
165
|
-
##
|
165
|
+
## delete_recording_transcription
|
166
166
|
|
167
|
-
>
|
167
|
+
> delete_recording_transcription(account_id, call_id, recording_id)
|
168
168
|
|
169
|
-
Delete
|
169
|
+
Delete Transcription
|
170
170
|
|
171
|
-
Deletes the specified recording's
|
171
|
+
Deletes the specified recording's transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
172
172
|
|
173
173
|
### Examples
|
174
174
|
|
@@ -188,28 +188,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
|
|
188
188
|
recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
|
189
189
|
|
190
190
|
begin
|
191
|
-
# Delete
|
192
|
-
api_instance.
|
191
|
+
# Delete Transcription
|
192
|
+
api_instance.delete_recording_transcription(account_id, call_id, recording_id)
|
193
193
|
rescue Bandwidth::ApiError => e
|
194
|
-
puts "Error when calling RecordingsApi->
|
194
|
+
puts "Error when calling RecordingsApi->delete_recording_transcription: #{e}"
|
195
195
|
end
|
196
196
|
```
|
197
197
|
|
198
|
-
#### Using the
|
198
|
+
#### Using the delete_recording_transcription_with_http_info variant
|
199
199
|
|
200
200
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
201
201
|
|
202
|
-
> <Array(nil, Integer, Hash)>
|
202
|
+
> <Array(nil, Integer, Hash)> delete_recording_transcription_with_http_info(account_id, call_id, recording_id)
|
203
203
|
|
204
204
|
```ruby
|
205
205
|
begin
|
206
|
-
# Delete
|
207
|
-
data, status_code, headers = api_instance.
|
206
|
+
# Delete Transcription
|
207
|
+
data, status_code, headers = api_instance.delete_recording_transcription_with_http_info(account_id, call_id, recording_id)
|
208
208
|
p status_code # => 2xx
|
209
209
|
p headers # => { ... }
|
210
210
|
p data # => nil
|
211
211
|
rescue Bandwidth::ApiError => e
|
212
|
-
puts "Error when calling RecordingsApi->
|
212
|
+
puts "Error when calling RecordingsApi->delete_recording_transcription_with_http_info: #{e}"
|
213
213
|
end
|
214
214
|
```
|
215
215
|
|
@@ -383,13 +383,13 @@ end
|
|
383
383
|
- **Accept**: application/json
|
384
384
|
|
385
385
|
|
386
|
-
##
|
386
|
+
## get_recording_transcription
|
387
387
|
|
388
|
-
> <
|
388
|
+
> <RecordingTranscriptions> get_recording_transcription(account_id, call_id, recording_id)
|
389
389
|
|
390
390
|
Get Transcription
|
391
391
|
|
392
|
-
Downloads the specified transcription.
|
392
|
+
Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
393
393
|
|
394
394
|
### Examples
|
395
395
|
|
@@ -410,28 +410,28 @@ recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Prog
|
|
410
410
|
|
411
411
|
begin
|
412
412
|
# Get Transcription
|
413
|
-
result = api_instance.
|
413
|
+
result = api_instance.get_recording_transcription(account_id, call_id, recording_id)
|
414
414
|
p result
|
415
415
|
rescue Bandwidth::ApiError => e
|
416
|
-
puts "Error when calling RecordingsApi->
|
416
|
+
puts "Error when calling RecordingsApi->get_recording_transcription: #{e}"
|
417
417
|
end
|
418
418
|
```
|
419
419
|
|
420
|
-
#### Using the
|
420
|
+
#### Using the get_recording_transcription_with_http_info variant
|
421
421
|
|
422
422
|
This returns an Array which contains the response data, status code and headers.
|
423
423
|
|
424
|
-
> <Array(<
|
424
|
+
> <Array(<RecordingTranscriptions>, Integer, Hash)> get_recording_transcription_with_http_info(account_id, call_id, recording_id)
|
425
425
|
|
426
426
|
```ruby
|
427
427
|
begin
|
428
428
|
# Get Transcription
|
429
|
-
data, status_code, headers = api_instance.
|
429
|
+
data, status_code, headers = api_instance.get_recording_transcription_with_http_info(account_id, call_id, recording_id)
|
430
430
|
p status_code # => 2xx
|
431
431
|
p headers # => { ... }
|
432
|
-
p data # => <
|
432
|
+
p data # => <RecordingTranscriptions>
|
433
433
|
rescue Bandwidth::ApiError => e
|
434
|
-
puts "Error when calling RecordingsApi->
|
434
|
+
puts "Error when calling RecordingsApi->get_recording_transcription_with_http_info: #{e}"
|
435
435
|
end
|
436
436
|
```
|
437
437
|
|
@@ -445,7 +445,7 @@ end
|
|
445
445
|
|
446
446
|
### Return type
|
447
447
|
|
448
|
-
[**
|
448
|
+
[**RecordingTranscriptions**](RecordingTranscriptions.md)
|
449
449
|
|
450
450
|
### Authorization
|
451
451
|
|
@@ -0,0 +1,229 @@
|
|
1
|
+
# Bandwidth::TranscriptionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
|
8
|
+
| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
|
9
|
+
| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
|
10
|
+
|
11
|
+
|
12
|
+
## delete_real_time_transcription
|
13
|
+
|
14
|
+
> delete_real_time_transcription(account_id, call_id, transcription_id)
|
15
|
+
|
16
|
+
Delete a specific transcription
|
17
|
+
|
18
|
+
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'bandwidth-sdk'
|
25
|
+
# setup authorization
|
26
|
+
Bandwidth.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = Bandwidth::TranscriptionsApi.new
|
33
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
34
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
35
|
+
transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Delete a specific transcription
|
39
|
+
api_instance.delete_real_time_transcription(account_id, call_id, transcription_id)
|
40
|
+
rescue Bandwidth::ApiError => e
|
41
|
+
puts "Error when calling TranscriptionsApi->delete_real_time_transcription: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the delete_real_time_transcription_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
48
|
+
|
49
|
+
> <Array(nil, Integer, Hash)> delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# Delete a specific transcription
|
54
|
+
data, status_code, headers = api_instance.delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => nil
|
58
|
+
rescue Bandwidth::ApiError => e
|
59
|
+
puts "Error when calling TranscriptionsApi->delete_real_time_transcription_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
68
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
69
|
+
| **transcription_id** | **String** | Programmable Voice API Transcription ID. | |
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
nil (empty response body)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
[Basic](../README.md#Basic)
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
## get_real_time_transcription
|
86
|
+
|
87
|
+
> <CallTranscriptionResponse> get_real_time_transcription(account_id, call_id, transcription_id)
|
88
|
+
|
89
|
+
Retrieve a specific transcription
|
90
|
+
|
91
|
+
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
92
|
+
|
93
|
+
### Examples
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
require 'time'
|
97
|
+
require 'bandwidth-sdk'
|
98
|
+
# setup authorization
|
99
|
+
Bandwidth.configure do |config|
|
100
|
+
# Configure HTTP basic authorization: Basic
|
101
|
+
config.username = 'YOUR USERNAME'
|
102
|
+
config.password = 'YOUR PASSWORD'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Bandwidth::TranscriptionsApi.new
|
106
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
107
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
108
|
+
transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
|
109
|
+
|
110
|
+
begin
|
111
|
+
# Retrieve a specific transcription
|
112
|
+
result = api_instance.get_real_time_transcription(account_id, call_id, transcription_id)
|
113
|
+
p result
|
114
|
+
rescue Bandwidth::ApiError => e
|
115
|
+
puts "Error when calling TranscriptionsApi->get_real_time_transcription: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
#### Using the get_real_time_transcription_with_http_info variant
|
120
|
+
|
121
|
+
This returns an Array which contains the response data, status code and headers.
|
122
|
+
|
123
|
+
> <Array(<CallTranscriptionResponse>, Integer, Hash)> get_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
|
124
|
+
|
125
|
+
```ruby
|
126
|
+
begin
|
127
|
+
# Retrieve a specific transcription
|
128
|
+
data, status_code, headers = api_instance.get_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
|
129
|
+
p status_code # => 2xx
|
130
|
+
p headers # => { ... }
|
131
|
+
p data # => <CallTranscriptionResponse>
|
132
|
+
rescue Bandwidth::ApiError => e
|
133
|
+
puts "Error when calling TranscriptionsApi->get_real_time_transcription_with_http_info: #{e}"
|
134
|
+
end
|
135
|
+
```
|
136
|
+
|
137
|
+
### Parameters
|
138
|
+
|
139
|
+
| Name | Type | Description | Notes |
|
140
|
+
| ---- | ---- | ----------- | ----- |
|
141
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
142
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
143
|
+
| **transcription_id** | **String** | Programmable Voice API Transcription ID. | |
|
144
|
+
|
145
|
+
### Return type
|
146
|
+
|
147
|
+
[**CallTranscriptionResponse**](CallTranscriptionResponse.md)
|
148
|
+
|
149
|
+
### Authorization
|
150
|
+
|
151
|
+
[Basic](../README.md#Basic)
|
152
|
+
|
153
|
+
### HTTP request headers
|
154
|
+
|
155
|
+
- **Content-Type**: Not defined
|
156
|
+
- **Accept**: application/json
|
157
|
+
|
158
|
+
|
159
|
+
## list_real_time_transcriptions
|
160
|
+
|
161
|
+
> <Array<CallTranscriptionMetadata>> list_real_time_transcriptions(account_id, call_id)
|
162
|
+
|
163
|
+
Enumerate transcriptions made with StartTranscription
|
164
|
+
|
165
|
+
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
166
|
+
|
167
|
+
### Examples
|
168
|
+
|
169
|
+
```ruby
|
170
|
+
require 'time'
|
171
|
+
require 'bandwidth-sdk'
|
172
|
+
# setup authorization
|
173
|
+
Bandwidth.configure do |config|
|
174
|
+
# Configure HTTP basic authorization: Basic
|
175
|
+
config.username = 'YOUR USERNAME'
|
176
|
+
config.password = 'YOUR PASSWORD'
|
177
|
+
end
|
178
|
+
|
179
|
+
api_instance = Bandwidth::TranscriptionsApi.new
|
180
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
181
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
182
|
+
|
183
|
+
begin
|
184
|
+
# Enumerate transcriptions made with StartTranscription
|
185
|
+
result = api_instance.list_real_time_transcriptions(account_id, call_id)
|
186
|
+
p result
|
187
|
+
rescue Bandwidth::ApiError => e
|
188
|
+
puts "Error when calling TranscriptionsApi->list_real_time_transcriptions: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
#### Using the list_real_time_transcriptions_with_http_info variant
|
193
|
+
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
195
|
+
|
196
|
+
> <Array(<Array<CallTranscriptionMetadata>>, Integer, Hash)> list_real_time_transcriptions_with_http_info(account_id, call_id)
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
begin
|
200
|
+
# Enumerate transcriptions made with StartTranscription
|
201
|
+
data, status_code, headers = api_instance.list_real_time_transcriptions_with_http_info(account_id, call_id)
|
202
|
+
p status_code # => 2xx
|
203
|
+
p headers # => { ... }
|
204
|
+
p data # => <Array<CallTranscriptionMetadata>>
|
205
|
+
rescue Bandwidth::ApiError => e
|
206
|
+
puts "Error when calling TranscriptionsApi->list_real_time_transcriptions_with_http_info: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
### Parameters
|
211
|
+
|
212
|
+
| Name | Type | Description | Notes |
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
214
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
215
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
216
|
+
|
217
|
+
### Return type
|
218
|
+
|
219
|
+
[**Array<CallTranscriptionMetadata>**](CallTranscriptionMetadata.md)
|
220
|
+
|
221
|
+
### Authorization
|
222
|
+
|
223
|
+
[Basic](../README.md#Basic)
|
224
|
+
|
225
|
+
### HTTP request headers
|
226
|
+
|
227
|
+
- **Content-Type**: Not defined
|
228
|
+
- **Accept**: application/json
|
229
|
+
|