Skip to content

Latest commit

 

History

History
202 lines (142 loc) · 6.75 KB

TranscriptionsApi.md

File metadata and controls

202 lines (142 loc) · 6.75 KB

TranscriptionsApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteRealTimeTranscription DELETE /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} Delete Real-time Transcription
getRealTimeTranscription GET /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} Get Real-time Transcription
listRealTimeTranscriptions GET /accounts/{accountId}/calls/{callId}/transcriptions List Real-time Transcriptions

deleteRealTimeTranscription

deleteRealTimeTranscription()

Delete the specified transcription that was created on this call via 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.

Example

import {
    TranscriptionsApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new TranscriptionsApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let callId: string; //Programmable Voice API Call ID. (default to undefined)
let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined)

const { status, data } = await apiInstance.deleteRealTimeTranscription(
    accountId,
    callId,
    transcriptionId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
callId [string] Programmable Voice API Call ID. defaults to undefined
transcriptionId [string] Programmable Voice API Transcription ID. defaults to undefined

Return type

void (empty response body)

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 No Content -
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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRealTimeTranscription

CallTranscriptionResponse getRealTimeTranscription()

Retrieve the specified transcription that was created on this call via startTranscription.

Example

import {
    TranscriptionsApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new TranscriptionsApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let callId: string; //Programmable Voice API Call ID. (default to undefined)
let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined)

const { status, data } = await apiInstance.getRealTimeTranscription(
    accountId,
    callId,
    transcriptionId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
callId [string] Programmable Voice API Call ID. defaults to undefined
transcriptionId [string] Programmable Voice API Transcription ID. defaults to undefined

Return type

CallTranscriptionResponse

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRealTimeTranscriptions

Array listRealTimeTranscriptions()

List the transcriptions created on this call via startTranscription.

Example

import {
    TranscriptionsApi,
    Configuration
} from 'bandwidth-sdk';

const configuration = new Configuration();
const apiInstance = new TranscriptionsApi(configuration);

let accountId: string; //Your Bandwidth Account ID. (default to undefined)
let callId: string; //Programmable Voice API Call ID. (default to undefined)

const { status, data } = await apiInstance.listRealTimeTranscriptions(
    accountId,
    callId
);

Parameters

Name Type Description Notes
accountId [string] Your Bandwidth Account ID. defaults to undefined
callId [string] Programmable Voice API Call ID. defaults to undefined

Return type

Array

Authorization

Basic, OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]