You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
38
-
* @summary Delete a specific transcription
38
+
* @summary Delete Real-time Transcription
39
39
* @param {string} accountId Your Bandwidth Account ID.
40
40
* @param {string} callId Programmable Voice API Call ID.
41
41
* @param {string} transcriptionId Programmable Voice API Transcription ID.
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
182
-
* @summary Delete a specific transcription
182
+
* @summary Delete Real-time Transcription
183
183
* @param {string} accountId Your Bandwidth Account ID.
184
184
* @param {string} callId Programmable Voice API Call ID.
185
185
* @param {string} transcriptionId Programmable Voice API Transcription ID.
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
236
-
* @summary Delete a specific transcription
236
+
* @summary Delete Real-time Transcription
237
237
* @param {string} accountId Your Bandwidth Account ID.
238
238
* @param {string} callId Programmable Voice API Call ID.
239
239
* @param {string} transcriptionId Programmable Voice API Transcription ID.
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
281
-
* @summary Delete a specific transcription
281
+
* @summary Delete Real-time Transcription
282
282
* @param {string} accountId Your Bandwidth Account ID.
283
283
* @param {string} callId Programmable Voice API Call ID.
284
284
* @param {string} transcriptionId Programmable Voice API Transcription ID.
@@ -292,7 +292,7 @@ export class TranscriptionsApi extends BaseAPI {
292
292
293
293
/**
294
294
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
295
-
* @summaryRetrieve a specific transcription
295
+
* @summaryGet Real-time Transcription
296
296
* @param {string} accountId Your Bandwidth Account ID.
297
297
* @param {string} callId Programmable Voice API Call ID.
298
298
* @param {string} transcriptionId Programmable Voice API Transcription ID.
@@ -305,8 +305,8 @@ export class TranscriptionsApi extends BaseAPI {
305
305
}
306
306
307
307
/**
308
-
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
309
-
* @summaryEnumerate transcriptions made with StartTranscription
308
+
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
309
+
* @summaryList Real-time Transcriptions
310
310
* @param {string} accountId Your Bandwidth Account ID.
311
311
* @param {string} callId Programmable Voice API Call ID.
**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional][default to undefined]
9
9
**transcriptionName** | **string** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional][default to undefined]
10
-
**transcriptionUrl** | **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][default to undefined]
10
+
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional][default to undefined]
**callId** | **string** | The call id associated with the event. | [optional][default to undefined]
9
9
**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional][default to undefined]
10
-
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional][default to undefined]
10
+
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional][default to undefined]
11
11
**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member\'s mute status. Has no effect if omitted. | [optional][default to undefined]
12
12
**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member\'s hold status. Has no effect if omitted. | [optional][default to undefined]
13
13
**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional][default to undefined]
Copy file name to clipboardExpand all lines: docs/TranscriptionsApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ All URIs are relative to *http://localhost*
4
4
5
5
|Method | HTTP request | Description|
6
6
|------------- | ------------- | -------------|
7
-
|[**deleteRealTimeTranscription**](#deleterealtimetranscription)|**DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription|
8
-
|[**getRealTimeTranscription**](#getrealtimetranscription)|**GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} |Retrieve a specific transcription|
9
-
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions)|**GET** /accounts/{accountId}/calls/{callId}/transcriptions |Enumerate transcriptions made with StartTranscription|
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
36
+
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
36
+
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.
![band-swi-release-engineering[bot]](https://avatars.githubusercontent.com/u/20689391?v=4&size=40){kind=avatar}
0 commit comments