Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
27 lines (20 loc) · 2.35 KB

transcriptions.md

File metadata and controls

27 lines (20 loc) · 2.35 KB

Transcriptions

The Transcription resource lets you transcribe a call audio recording to extract voicemail information. This resource can be either created automatically when the call property transcriptionEnabled is set to true, when call is created, or during the call by posting an event. By enabling/disabling call property recordingEnabled, a call can have more than one recording, so it's possible to have one or more transcriptions for each one of those recordings. When transcriptionEnabled is set to true all the recordings generated within that call are going to be transcribed, i.e, if you start to record a call, at any given time when the call is active, and then terminate the recording, the transcription resource will be automatically started for this recording; this process can happen many times.

It is important to note that our transcription service has been specifically tuned to transcribe voicemail recordings. It will not perform accurately when used in other scenarios such as IVR or support conversation recording.

Base URL

https://api.catapult.inetwork.com/v1/users/{userId}/recordings/{recordingId}/transcriptions/

Capabilities

Verb Path about
POST /v1/users/{userId}/recordings/{recordingId}/transcriptions Create a new transcription
GET /v1/users/{userId}/recordings/{recordingId}/transcriptions Get all transcriptions for a recording resource
GET /v1/users/{userId}/recordings/{recordingId}/transcriptions/{transcriptionId} Get properties for a specific transcription

If you are interested in using transcription for these use cases, please contact us at [email protected].