Package com.bandwidth.sdk.api

Class RecordingsApi

java.lang.Object

com.bandwidth.sdk.api.RecordingsApi

public class RecordingsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RecordingsApi()
RecordingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteCallTranscription(String accountId, String callId, String recordingId)	Delete Transcription Deletes the specified recording's transcription.
okhttp3.Call	deleteCallTranscriptionAsync(String accountId, String callId, String recordingId, ApiCallback<Void> _callback)	Delete Transcription (asynchronously) Deletes the specified recording's transcription.
okhttp3.Call	deleteCallTranscriptionCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for deleteCallTranscription
ApiResponse<Void>	deleteCallTranscriptionWithHttpInfo(String accountId, String callId, String recordingId)	Delete Transcription Deletes the specified recording's transcription.
void	deleteRecording(String accountId, String callId, String recordingId)	Delete Recording Delete the recording information, media and transcription.
okhttp3.Call	deleteRecordingAsync(String accountId, String callId, String recordingId, ApiCallback<Void> _callback)	Delete Recording (asynchronously) Delete the recording information, media and transcription.
okhttp3.Call	deleteRecordingCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for deleteRecording
void	deleteRecordingMedia(String accountId, String callId, String recordingId)	Delete Recording Media Deletes the specified recording's media.
okhttp3.Call	deleteRecordingMediaAsync(String accountId, String callId, String recordingId, ApiCallback<Void> _callback)	Delete Recording Media (asynchronously) Deletes the specified recording's media.
okhttp3.Call	deleteRecordingMediaCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for deleteRecordingMedia
ApiResponse<Void>	deleteRecordingMediaWithHttpInfo(String accountId, String callId, String recordingId)	Delete Recording Media Deletes the specified recording's media.
ApiResponse<Void>	deleteRecordingWithHttpInfo(String accountId, String callId, String recordingId)	Delete Recording Delete the recording information, media and transcription.
File	downloadCallRecording(String accountId, String callId, String recordingId)	Download Recording Downloads the specified recording.
okhttp3.Call	downloadCallRecordingAsync(String accountId, String callId, String recordingId, ApiCallback<File> _callback)	Download Recording (asynchronously) Downloads the specified recording.
okhttp3.Call	downloadCallRecordingCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for downloadCallRecording
ApiResponse<File>	downloadCallRecordingWithHttpInfo(String accountId, String callId, String recordingId)	Download Recording Downloads the specified recording.
ApiClient	getApiClient()
CallRecordingMetadata	getCallRecording(String accountId, String callId, String recordingId)	Get Call Recording Returns metadata for the specified recording.
okhttp3.Call	getCallRecordingAsync(String accountId, String callId, String recordingId, ApiCallback<CallRecordingMetadata> _callback)	Get Call Recording (asynchronously) Returns metadata for the specified recording.
okhttp3.Call	getCallRecordingCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for getCallRecording
ApiResponse<CallRecordingMetadata>	getCallRecordingWithHttpInfo(String accountId, String callId, String recordingId)	Get Call Recording Returns metadata for the specified recording.
TranscriptionList	getCallTranscription(String accountId, String callId, String recordingId)	Get Transcription Downloads the specified transcription.
okhttp3.Call	getCallTranscriptionAsync(String accountId, String callId, String recordingId, ApiCallback<TranscriptionList> _callback)	Get Transcription (asynchronously) Downloads the specified transcription.
okhttp3.Call	getCallTranscriptionCall(String accountId, String callId, String recordingId, ApiCallback _callback)	Build call for getCallTranscription
ApiResponse<TranscriptionList>	getCallTranscriptionWithHttpInfo(String accountId, String callId, String recordingId)	Get Transcription Downloads the specified transcription.
String	getCustomBaseUrl()
int	getHostIndex()
List<CallRecordingMetadata>	listAccountCallRecordings(String accountId, String to, String from, String minStartTime, String maxStartTime)	Get Call Recordings Returns a list of metadata for the recordings associated with the specified account.
okhttp3.Call	listAccountCallRecordingsAsync(String accountId, String to, String from, String minStartTime, String maxStartTime, ApiCallback<List<CallRecordingMetadata>> _callback)	Get Call Recordings (asynchronously) Returns a list of metadata for the recordings associated with the specified account.
okhttp3.Call	listAccountCallRecordingsCall(String accountId, String to, String from, String minStartTime, String maxStartTime, ApiCallback _callback)	Build call for listAccountCallRecordings
ApiResponse<List<CallRecordingMetadata>>	listAccountCallRecordingsWithHttpInfo(String accountId, String to, String from, String minStartTime, String maxStartTime)	Get Call Recordings Returns a list of metadata for the recordings associated with the specified account.
List<CallRecordingMetadata>	listCallRecordings(String accountId, String callId)	List Call Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
okhttp3.Call	listCallRecordingsAsync(String accountId, String callId, ApiCallback<List<CallRecordingMetadata>> _callback)	List Call Recordings (asynchronously) Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
okhttp3.Call	listCallRecordingsCall(String accountId, String callId, ApiCallback _callback)	Build call for listCallRecordings
ApiResponse<List<CallRecordingMetadata>>	listCallRecordingsWithHttpInfo(String accountId, String callId)	List Call Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	transcribeCallRecording(String accountId, String callId, String recordingId, TranscribeRecording transcribeRecording)	Create Transcription Request Generate the transcription for a specific recording.
okhttp3.Call	transcribeCallRecordingAsync(String accountId, String callId, String recordingId, TranscribeRecording transcribeRecording, ApiCallback<Void> _callback)	Create Transcription Request (asynchronously) Generate the transcription for a specific recording.
okhttp3.Call	transcribeCallRecordingCall(String accountId, String callId, String recordingId, TranscribeRecording transcribeRecording, ApiCallback _callback)	Build call for transcribeCallRecording
ApiResponse<Void>	transcribeCallRecordingWithHttpInfo(String accountId, String callId, String recordingId, TranscribeRecording transcribeRecording)	Create Transcription Request Generate the transcription for a specific recording.
void	updateCallRecordingState(String accountId, String callId, UpdateCallRecording updateCallRecording)	Update Recording Pause or resume a recording on an active phone call.
okhttp3.Call	updateCallRecordingStateAsync(String accountId, String callId, UpdateCallRecording updateCallRecording, ApiCallback<Void> _callback)	Update Recording (asynchronously) Pause or resume a recording on an active phone call.
okhttp3.Call	updateCallRecordingStateCall(String accountId, String callId, UpdateCallRecording updateCallRecording, ApiCallback _callback)	Build call for updateCallRecordingState
ApiResponse<Void>	updateCallRecordingStateWithHttpInfo(String accountId, String callId, UpdateCallRecording updateCallRecording)	Update Recording Pause or resume a recording on an active phone call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordingsApi

public RecordingsApi()

RecordingsApi

public RecordingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

deleteCallTranscriptionCall

public okhttp3.Call deleteCallTranscriptionCall(String accountId,
                                                String callId,
                                                String recordingId,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for deleteCallTranscription

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	The transcription was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteCallTranscription

public void deleteCallTranscription(String accountId,
                                    String callId,
                                    String recordingId)
                             throws ApiException

Delete Transcription 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	The transcription was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteCallTranscriptionWithHttpInfo

public ApiResponse<Void> deleteCallTranscriptionWithHttpInfo(String accountId,
                                                             String callId,
                                                             String recordingId)
                                                      throws ApiException

Delete Transcription 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	The transcription was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteCallTranscriptionAsync

public okhttp3.Call deleteCallTranscriptionAsync(String accountId,
                                                 String callId,
                                                 String recordingId,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException

Delete Transcription (asynchronously) 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	The transcription was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingCall

public okhttp3.Call deleteRecordingCall(String accountId,
                                        String callId,
                                        String recordingId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for deleteRecording

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Recording was deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecording

public void deleteRecording(String accountId,
                            String callId,
                            String recordingId)
                     throws ApiException

Delete Recording 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Recording was deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingWithHttpInfo

public ApiResponse<Void> deleteRecordingWithHttpInfo(String accountId,
                                                     String callId,
                                                     String recordingId)
                                              throws ApiException

Delete Recording 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Recording was deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingAsync

public okhttp3.Call deleteRecordingAsync(String accountId,
                                         String callId,
                                         String recordingId,
                                         ApiCallback<Void> _callback)
                                  throws ApiException

Delete Recording (asynchronously) 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Recording was deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingMediaCall

public okhttp3.Call deleteRecordingMediaCall(String accountId,
                                             String callId,
                                             String recordingId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for deleteRecordingMedia

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	The recording media was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingMedia

public void deleteRecordingMedia(String accountId,
                                 String callId,
                                 String recordingId)
                          throws ApiException

Delete Recording Media Deletes the specified recording's media.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	The recording media was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingMediaWithHttpInfo

public ApiResponse<Void> deleteRecordingMediaWithHttpInfo(String accountId,
                                                          String callId,
                                                          String recordingId)
                                                   throws ApiException

Delete Recording Media Deletes the specified recording's media.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	The recording media was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

deleteRecordingMediaAsync

public okhttp3.Call deleteRecordingMediaAsync(String accountId,
                                              String callId,
                                              String recordingId,
                                              ApiCallback<Void> _callback)
                                       throws ApiException

Delete Recording Media (asynchronously) Deletes the specified recording's media.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	The recording media was successfully deleted.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

downloadCallRecordingCall

public okhttp3.Call downloadCallRecordingCall(String accountId,
                                              String callId,
                                              String recordingId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for downloadCallRecording

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Media found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

downloadCallRecording

public File downloadCallRecording(String accountId,
                                  String callId,
                                  String recordingId)
                           throws ApiException

Download Recording Downloads the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Media found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

downloadCallRecordingWithHttpInfo

public ApiResponse<File> downloadCallRecordingWithHttpInfo(String accountId,
                                                           String callId,
                                                           String recordingId)
                                                    throws ApiException

Download Recording Downloads the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Media found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

downloadCallRecordingAsync

public okhttp3.Call downloadCallRecordingAsync(String accountId,
                                               String callId,
                                               String recordingId,
                                               ApiCallback<File> _callback)
                                        throws ApiException

Download Recording (asynchronously) Downloads the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Media found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallRecordingCall

public okhttp3.Call getCallRecordingCall(String accountId,
                                         String callId,
                                         String recordingId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getCallRecording

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recording found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallRecording

public CallRecordingMetadata getCallRecording(String accountId,
                                              String callId,
                                              String recordingId)
                                       throws ApiException

Get Call Recording Returns metadata for the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

CallRecordingMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recording found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallRecordingWithHttpInfo

public ApiResponse<CallRecordingMetadata> getCallRecordingWithHttpInfo(String accountId,
                                                                       String callId,
                                                                       String recordingId)
                                                                throws ApiException

Get Call Recording Returns metadata for the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<CallRecordingMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recording found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallRecordingAsync

public okhttp3.Call getCallRecordingAsync(String accountId,
                                          String callId,
                                          String recordingId,
                                          ApiCallback<CallRecordingMetadata> _callback)
                                   throws ApiException

Get Call Recording (asynchronously) Returns metadata for the specified recording.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recording found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallTranscriptionCall

public okhttp3.Call getCallTranscriptionCall(String accountId,
                                             String callId,
                                             String recordingId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getCallTranscription

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Transcription found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallTranscription

public TranscriptionList getCallTranscription(String accountId,
                                              String callId,
                                              String recordingId)
                                       throws ApiException

Get Transcription Downloads the specified transcription. If the transcribed 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

TranscriptionList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Transcription found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallTranscriptionWithHttpInfo

public ApiResponse<TranscriptionList> getCallTranscriptionWithHttpInfo(String accountId,
                                                                       String callId,
                                                                       String recordingId)
                                                                throws ApiException

Get Transcription Downloads the specified transcription. If the transcribed 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

Returns:

ApiResponse<TranscriptionList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Transcription found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getCallTranscriptionAsync

public okhttp3.Call getCallTranscriptionAsync(String accountId,
                                              String callId,
                                              String recordingId,
                                              ApiCallback<TranscriptionList> _callback)
                                       throws ApiException

Get Transcription (asynchronously) Downloads the specified transcription. If the transcribed 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.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Transcription found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listAccountCallRecordingsCall

public okhttp3.Call listAccountCallRecordingsCall(String accountId,
                                                  String to,
                                                  String from,
                                                  String minStartTime,
                                                  String maxStartTime,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for listAccountCallRecordings

Parameters:

accountId - Your Bandwidth Account ID. (required)

to - Filter results by the `to` field. (optional)

from - Filter results by the `from` field. (optional)

minStartTime - Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional)

maxStartTime - Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listAccountCallRecordings

public List<CallRecordingMetadata> listAccountCallRecordings(String accountId,
                                                             String to,
                                                             String from,
                                                             String minStartTime,
                                                             String maxStartTime)
                                                      throws ApiException

Get Call Recordings Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.

Parameters:

accountId - Your Bandwidth Account ID. (required)

to - Filter results by the `to` field. (optional)

from - Filter results by the `from` field. (optional)

minStartTime - Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional)

maxStartTime - Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional)

Returns:

List<CallRecordingMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listAccountCallRecordingsWithHttpInfo

public ApiResponse<List<CallRecordingMetadata>> listAccountCallRecordingsWithHttpInfo(String accountId,
                                                                                      String to,
                                                                                      String from,
                                                                                      String minStartTime,
                                                                                      String maxStartTime)
                                                                               throws ApiException

Get Call Recordings Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.

Parameters:

accountId - Your Bandwidth Account ID. (required)

to - Filter results by the `to` field. (optional)

from - Filter results by the `from` field. (optional)

minStartTime - Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional)

maxStartTime - Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional)

Returns:

ApiResponse<List<CallRecordingMetadata>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listAccountCallRecordingsAsync

public okhttp3.Call listAccountCallRecordingsAsync(String accountId,
                                                   String to,
                                                   String from,
                                                   String minStartTime,
                                                   String maxStartTime,
                                                   ApiCallback<List<CallRecordingMetadata>> _callback)
                                            throws ApiException

Get Call Recordings (asynchronously) Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.

Parameters:

accountId - Your Bandwidth Account ID. (required)

to - Filter results by the `to` field. (optional)

from - Filter results by the `from` field. (optional)

minStartTime - Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional)

maxStartTime - Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listCallRecordingsCall

public okhttp3.Call listCallRecordingsCall(String accountId,
                                           String callId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for listCallRecordings

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listCallRecordings

public List<CallRecordingMetadata> listCallRecordings(String accountId,
                                                      String callId)
                                               throws ApiException

List Call Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

Returns:

List<CallRecordingMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listCallRecordingsWithHttpInfo

public ApiResponse<List<CallRecordingMetadata>> listCallRecordingsWithHttpInfo(String accountId,
                                                                               String callId)
                                                                        throws ApiException

List Call Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

Returns:

ApiResponse<List<CallRecordingMetadata>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

listCallRecordingsAsync

public okhttp3.Call listCallRecordingsAsync(String accountId,
                                            String callId,
                                            ApiCallback<List<CallRecordingMetadata>> _callback)
                                     throws ApiException

List Call Recordings (asynchronously) Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recordings retrieved successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

transcribeCallRecordingCall

public okhttp3.Call transcribeCallRecordingCall(String accountId,
                                                String callId,
                                                String recordingId,
                                                TranscribeRecording transcribeRecording,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for transcribeCallRecording

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

transcribeRecording - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Transcription was successfully requested.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

transcribeCallRecording

public void transcribeCallRecording(String accountId,
                                    String callId,
                                    String recordingId,
                                    TranscribeRecording transcribeRecording)
                             throws ApiException

Create Transcription Request Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

transcribeRecording - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Transcription was successfully requested.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

transcribeCallRecordingWithHttpInfo

public ApiResponse<Void> transcribeCallRecordingWithHttpInfo(String accountId,
                                                             String callId,
                                                             String recordingId,
                                                             TranscribeRecording transcribeRecording)
                                                      throws ApiException

Create Transcription Request Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

transcribeRecording - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Transcription was successfully requested.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

transcribeCallRecordingAsync

public okhttp3.Call transcribeCallRecordingAsync(String accountId,
                                                 String callId,
                                                 String recordingId,
                                                 TranscribeRecording transcribeRecording,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException

Create Transcription Request (asynchronously) Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

recordingId - Programmable Voice API Recording ID. (required)

transcribeRecording - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Transcription was successfully requested.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

updateCallRecordingStateCall

public okhttp3.Call updateCallRecordingStateCall(String accountId,
                                                 String callId,
                                                 UpdateCallRecording updateCallRecording,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for updateCallRecordingState

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

updateCallRecording - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recording state was successfully modified.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

updateCallRecordingState

public void updateCallRecordingState(String accountId,
                                     String callId,
                                     UpdateCallRecording updateCallRecording)
                              throws ApiException

Update Recording Pause or resume a recording on an active phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

updateCallRecording - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recording state was successfully modified.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

updateCallRecordingStateWithHttpInfo

public ApiResponse<Void> updateCallRecordingStateWithHttpInfo(String accountId,
                                                              String callId,
                                                              UpdateCallRecording updateCallRecording)
                                                       throws ApiException

Update Recording Pause or resume a recording on an active phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

updateCallRecording - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Recording state was successfully modified.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

updateCallRecordingStateAsync

public okhttp3.Call updateCallRecordingStateAsync(String accountId,
                                                  String callId,
                                                  UpdateCallRecording updateCallRecording,
                                                  ApiCallback<Void> _callback)
                                           throws ApiException

Update Recording (asynchronously) Pause or resume a recording on an active phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

callId - Programmable Voice API Call ID. (required)

updateCallRecording - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Recording state was successfully modified.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-