Package com.bandwidth.sdk.api

Class TranscriptionsApi

java.lang.Object
com.bandwidth.sdk.api.TranscriptionsApi
public class TranscriptionsApi extends Object

  • Constructor Details

    • TranscriptionsApi

      public TranscriptionsApi()

    • TranscriptionsApi

      public TranscriptionsApi(ApiClient apiClient)

  • Method Details

    • 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)

    • deleteRealTimeTranscriptionCall

      public okhttp3.Call deleteRealTimeTranscriptionCall(String accountId, String callId, String transcriptionId, ApiCallback _callback) throws ApiException
      Build call for deleteRealTimeTranscription
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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 data 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 -

    • deleteRealTimeTranscription

      public void deleteRealTimeTranscription(String accountId, String callId, String transcriptionId) throws ApiException
      Delete a specific 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 `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.
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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
      200 Transcription data 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 -

    • deleteRealTimeTranscriptionWithHttpInfo

      public ApiResponse<Void> deleteRealTimeTranscriptionWithHttpInfo(String accountId, String callId, String transcriptionId) throws ApiException
      Delete a specific 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 `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.
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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
      200 Transcription data 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 -

    • deleteRealTimeTranscriptionAsync

      public okhttp3.Call deleteRealTimeTranscriptionAsync(String accountId, String callId, String transcriptionId, ApiCallback<Void> _callback) throws ApiException
      Delete a specific transcription (asynchronously) 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.
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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 data 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 -

    • getRealTimeTranscriptionCall

      public okhttp3.Call getRealTimeTranscriptionCall(String accountId, String callId, String transcriptionId, ApiCallback _callback) throws ApiException
      Build call for getRealTimeTranscription
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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 -

    • getRealTimeTranscription

      public CallTranscriptionResponse getRealTimeTranscription(String accountId, String callId, String transcriptionId) throws ApiException
      Retrieve a specific transcription Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription ID. (required)
      Returns:
      CallTranscriptionResponse
      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 -

    • getRealTimeTranscriptionWithHttpInfo

      public ApiResponse<CallTranscriptionResponse> getRealTimeTranscriptionWithHttpInfo(String accountId, String callId, String transcriptionId) throws ApiException
      Retrieve a specific transcription Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription ID. (required)
      Returns:
      ApiResponse<CallTranscriptionResponse>
      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 -

    • getRealTimeTranscriptionAsync

      public okhttp3.Call getRealTimeTranscriptionAsync(String accountId, String callId, String transcriptionId, ApiCallback<CallTranscriptionResponse> _callback) throws ApiException
      Retrieve a specific transcription (asynchronously) Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      transcriptionId - Programmable Voice API Transcription 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 -

    • listRealTimeTranscriptionsCall

      public okhttp3.Call listRealTimeTranscriptionsCall(String accountId, String callId, ApiCallback _callback) throws ApiException
      Build call for listRealTimeTranscriptions
      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 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 -

    • listRealTimeTranscriptions

      public List<CallTranscriptionMetadata> listRealTimeTranscriptions(String accountId, String callId) throws ApiException
      Enumerate transcriptions made with StartTranscription Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      Returns:
      List<CallTranscriptionMetadata>
      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 -

    • listRealTimeTranscriptionsWithHttpInfo

      public ApiResponse<List<CallTranscriptionMetadata>> listRealTimeTranscriptionsWithHttpInfo(String accountId, String callId) throws ApiException
      Enumerate transcriptions made with StartTranscription Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      Parameters:
      accountId - Your Bandwidth Account ID. (required)
      callId - Programmable Voice API Call ID. (required)
      Returns:
      ApiResponse<List<CallTranscriptionMetadata>>
      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 -

    • listRealTimeTranscriptionsAsync

      public okhttp3.Call listRealTimeTranscriptionsAsync(String accountId, String callId, ApiCallback<List<CallTranscriptionMetadata>> _callback) throws ApiException
      Enumerate transcriptions made with StartTranscription (asynchronously) Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
      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 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 -