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 exactly one of call_ids, campaign_lead_ids or lead_ids (each an array) 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 lead, agent, both.
  • min_duration (integer): minimum recording length in seconds. Default 1.
  • from, till (date-time): restrict to calls created within this range.

Returns. A nested results tree keyed by the selector you sent (calls, campaign_leads or leads). Each call entry reports whether it 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for sending existing calls to speech recognition. Exactly one of call_ids, campaign_lead_ids or lead_ids must be provided.

call_ids
array of integers

Array of call IDs (required unless campaign_lead_ids or lead_ids is set).

call_ids
campaign_lead_ids
array of integers

Array of campaign lead IDs (required unless call_ids or lead_ids is set).

campaign_lead_ids
lead_ids
array of integers

Array of lead IDs (required unless call_ids or campaign_lead_ids is set).

lead_ids
string
required

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

languages
array of strings
required

Speech recognition languages, up to 3.

languages*
string
required

Recording channels to transcribe. One of lead, agent, both.

integer

Minimum recording duration in seconds. Default 1.

date-time

Minimum call creation date.

date-time

Maximum call creation date.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json