Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Audio

Speech to Text Conversion

Returns Speech to Text Conversion to the provided webhook URI.

post/ai/audio/v1/async/speech-to-text

Query parameters

webhookstring uri required

The webhook URI to which the job response will be returned

Request body

contentUristring uri

Publicly facing uri

encoding'Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg' required

The encoding of the original audio

languageCodestring required

Language spoken in the audio file.

sourcestring

Source of the audio file eg: Phone, RingCentral, GoogleMeet, Zoom etc

audioType'CallCenter' | 'Meeting' | 'EarningsCalls' | 'Interview' | 'PressConference' | 'Voicemail'

Type of the audio

separateSpeakerPerChannelboolean

Indicates that the input audio is multi-channel and each channel has a separate speaker.

speakerCountinteger

Number of speakers in the file, omit parameter if unknown

speakerIdsstring[]

Optional set of speakers to be identified from the call.

enableVoiceActivityDetectionboolean

Apply voice activity detection.

enablePunctuationboolean

Enables Smart Punctuation API.

enableSpeakerDiarizationboolean

Tags each word corresponding to the speaker.

Example request

{
  "encoding": "Wav",
  "languageCode": "en-US",
  "source": "RingCentral",
  "audioType": "CallCenter",
  "speakerCount": 2,
  "speakerIds": [
    "speakerId1",
    "speakerId2"
  ],
  "speechContexts": [
    {
      "phrases": [
        "Mohit",
        "Sushant",
        "RingCentral"
      ]
    }
  ]
}

Response

Task accepted for processing.

jobIdstring