Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ Class | Method | HTTP request | Description
*TollFreeVerificationApi* | [**requestTollFreeVerification**](docs/TollFreeVerificationApi.md#requestTollFreeVerification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
*TollFreeVerificationApi* | [**updateTollFreeVerificationRequest**](docs/TollFreeVerificationApi.md#updateTollFreeVerificationRequest) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
*TollFreeVerificationApi* | [**updateWebhookSubscription**](docs/TollFreeVerificationApi.md#updateWebhookSubscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
*TranscriptionsApi* | [**deleteRealTimeTranscription**](docs/TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
*TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
*TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
*TranscriptionsApi* | [**deleteRealTimeTranscription**](docs/TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
*TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
*TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions


## Documentation for Models
Expand Down
24 changes: 12 additions & 12 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4155,7 +4155,7 @@ paths:
url: https://voice.bandwidth.com/api/v2
/accounts/{accountId}/calls/{callId}/transcriptions:
get:
description: "Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription)."
description: "List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription)."
operationId: listRealTimeTranscriptions
parameters:
- description: Your Bandwidth Account ID.
Expand Down Expand Up @@ -4262,7 +4262,7 @@ paths:
schema:
$ref: '#/components/schemas/voiceApiError'
description: Internal Server Error
summary: Enumerate transcriptions made with StartTranscription
summary: List Real-time Transcriptions
tags:
- Transcriptions
x-accepts:
Expand Down Expand Up @@ -4387,7 +4387,7 @@ paths:
schema:
$ref: '#/components/schemas/voiceApiError'
description: Internal Server Error
summary: Delete a specific transcription
summary: Delete Real-time Transcription
tags:
- Transcriptions
x-accepts:
Expand Down Expand Up @@ -4510,7 +4510,7 @@ paths:
schema:
$ref: '#/components/schemas/voiceApiError'
description: Internal Server Error
summary: Retrieve a specific transcription
summary: Get Real-time Transcription
tags:
- Transcriptions
x-accepts:
Expand Down Expand Up @@ -8246,7 +8246,7 @@ components:
- type
title: CreateMessageRequestError
type: object
messageId:
id:
description: The ID of the message.
example: 1589228074636lm4k2je7j7jklbn2
type: string
Expand Down Expand Up @@ -8569,8 +8569,8 @@ components:
text: Hello world
type: REPLY
text: Hello world
messageId: 1589228074636lm4k2je7j7jklbn2
expiration: 2021-02-01T11:29:18-05:00
id: 1589228074636lm4k2je7j7jklbn2
time: 2025-01-01T18:20:16Z
to:
- "+15554443333"
Expand Down Expand Up @@ -9236,16 +9236,16 @@ components:
text: Hello world
type: REPLY
text: Hello world
messageId: 1589228074636lm4k2je7j7jklbn2
expiration: 2021-02-01T11:29:18-05:00
id: 1589228074636lm4k2je7j7jklbn2
time: 2025-01-01T18:20:16Z
to:
- "+15554443333"
tag: custom string
priority: default
direction: in
properties:
messageId:
id:
description: The ID of the message.
example: 1589228074636lm4k2je7j7jklbn2
type: string
Expand Down Expand Up @@ -9290,7 +9290,7 @@ components:
required:
- channelList
- direction
- messageId
- id
- time
- to
type: object
Expand Down Expand Up @@ -10450,8 +10450,8 @@ components:
description: |-
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)
[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.
example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
format: uri
Expand Down Expand Up @@ -10789,7 +10789,7 @@ components:
transcriptionUrl:
description: |-
A URL that may be used to retrieve the transcription itself. This points to the
[Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
[Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
type: string
type: object
Expand Down
23 changes: 12 additions & 11 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1157,9 +1157,9 @@ paths:
get:
tags:
- Transcriptions
summary: Enumerate transcriptions made with StartTranscription
summary: List Real-time Transcriptions
description: >-
Enumerates the transcriptions created on this call via
List the transcriptions created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
operationId: listRealTimeTranscriptions
parameters:
Expand Down Expand Up @@ -1189,7 +1189,7 @@ paths:
get:
tags:
- Transcriptions
summary: Retrieve a specific transcription
summary: Get Real-time Transcription
description: >-
Retrieve the specified transcription that was created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
Expand Down Expand Up @@ -1220,7 +1220,7 @@ paths:
delete:
tags:
- Transcriptions
summary: Delete a specific transcription
summary: Delete Real-time Transcription
description: >-
Delete the specified transcription that was created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
Expand Down Expand Up @@ -1929,7 +1929,7 @@ components:
required:
- type
- description
messageId:
id:
type: string
description: The ID of the message.
example: 1589228074636lm4k2je7j7jklbn2
Expand Down Expand Up @@ -2549,8 +2549,8 @@ components:
description: The data returned in a multichannel message response.
type: object
properties:
messageId:
$ref: '#/components/schemas/messageId'
id:
$ref: '#/components/schemas/id'
time:
description: The time the message was received by the Bandwidth API.
type: string
Expand Down Expand Up @@ -2586,7 +2586,7 @@ components:
expiration:
$ref: '#/components/schemas/expiration'
required:
- messageId
- id
- time
- direction
- to
Expand Down Expand Up @@ -3738,11 +3738,12 @@ components:
the state of this conference member. This is the URL of this
member's

[Get Conference Member](/apis/voice/#operation/getConferenceMember)
[Get Conference
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
endpoint

and [Modify Conference
Member](/apis/voice/#operation/updateConferenceMember)
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)

endpoint.
example: >-
Expand Down Expand Up @@ -4094,7 +4095,7 @@ components:
points to the

[Get Call
Transcription](/apis/voice/#operation/getCallTranscription)
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
endpoint.
example: >-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
Expand Down
2 changes: 1 addition & 1 deletion docs/CallTranscriptionMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**transcriptionId** | **String** | The programmable voice API transcription ID. | [optional] |
|**transcriptionName** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
|**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] |
|**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] |



2 changes: 1 addition & 1 deletion docs/ConferenceMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**callId** | **String** | The call id associated with the event. | [optional] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**memberUrl** | **URI** | 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] |
|**memberUrl** | **URI** | 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] |
|**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] |
|**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] |
|**callIdsToCoach** | **List<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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/MultiChannelMessageResponseData.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The data returned in a multichannel message response.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**messageId** | **String** | The ID of the message. | |
|**id** | **String** | The ID of the message. | |
|**time** | **OffsetDateTime** | The time the message was received by the Bandwidth API. | |
|**direction** | **MessageDirectionEnum** | | |
|**to** | **Set<String>** | The destination phone number(s) of the message, in E164 format. | |
Expand Down
14 changes: 7 additions & 7 deletions docs/TranscriptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ All URIs are relative to *http://localhost*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**deleteRealTimeTranscription**](TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
| [**getRealTimeTranscription**](TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
| [**listRealTimeTranscriptions**](TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
| [**deleteRealTimeTranscription**](TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription |
| [**getRealTimeTranscription**](TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription |
| [**listRealTimeTranscriptions**](TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions |


<a id="deleteRealTimeTranscription"></a>
# **deleteRealTimeTranscription**
> deleteRealTimeTranscription(accountId, callId, transcriptionId)

Delete a specific transcription
Delete Real-time Transcription

Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a &#x60;200&#x60; 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.

Expand Down Expand Up @@ -92,7 +92,7 @@ null (empty response body)
# **getRealTimeTranscription**
> CallTranscriptionResponse getRealTimeTranscription(accountId, callId, transcriptionId)

Retrieve a specific transcription
Get Real-time Transcription

Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).

Expand Down Expand Up @@ -172,9 +172,9 @@ public class Example {
# **listRealTimeTranscriptions**
> List&lt;CallTranscriptionMetadata&gt; listRealTimeTranscriptions(accountId, callId)

Enumerate transcriptions made with StartTranscription
List Real-time Transcriptions

Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).

### Example
```java
Expand Down
Loading