Speech-Recognition

Send to speech recognition

Send existing call recordings to speech recognition for transcription.

When to use. Transcribe calls that were recorded earlier but not yet processed. To retrieve a finished transcription for a single call, use GET /speech-recognition/{call_id}. To search transcribed calls and have results delivered to your own endpoint, use GET /speech-recognition with a callback URL.

Request body. Provide call_ids (an array of call IDs) to select the calls, plus:

  • token (string, required): your speech recognition token. To obtain a token, contact your account manager.
  • languages (array, required): up to three language codes to transcribe.
  • recording_side (string, required): which channel to transcribe. One of caller, callee, both.
  • min_duration (integer): minimum recording length in seconds. Default 1.
  • from, till (date-time): restrict to calls created within this range.

Returns. A results object with a calls map keyed by call ID. Each entry reports whether the call was accepted for transcription, or the reason it was skipped (for example the recording is still being prepared, or the call was already sent).

Note. Only the token used to submit a call can later retrieve that call's transcription.

post/{sub_domain}/api/speech-recognition

Request

  • Base URL
    https://api.commpeak.com/pbx
  • URL
    https://api.commpeak.com/pbx/{sub_domain}/api/speech-recognition
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

PBX Name (subdomain)

Request body

call_idsinteger[] required

Array of call IDs to send for transcription.

tokenstring required

Speech recognition token. To obtain a token, contact your account manager.

languagesstring[] required

Speech recognition languages, up to 3.

recording_sidestring required

Recording channels to transcribe. One of caller, callee, both.

min_durationinteger nullable

Minimum recording duration in seconds. Default 1.

fromstring nullable

Minimum call creation date.

tillstring nullable

Maximum call creation date.

Response

Successful Response

resultsobject required

Nested result tree. The shape depends on the filter used in the request; each leaf call entry is a SpeechResult object.

Changes

No recorded changes to this operation across all 1 revision of this API.