channels
voice
calls
call-legs
calls-operations

Capture Speech

Capture speech on a call.

post/calls/1/calls/{callId}/capture/speech

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

callIdstring required

Call ID.

Request body

language'af-ZA' | 'sq-AL' | 'am-ET' | 'ar-KW' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IL' | 'ar-IQ' | 'ar-JO' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-PS' | 'ar-QA' | 'ar-SA' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'hy-AM' | 'az-AZ' | 'eu-ES' | 'bn-IN' | 'bn-BD' | 'bs-BA' | 'bg-BG' | 'my-MM' | 'ca-ES' | 'zh-CN' | 'zh-HK' | 'zh-TW' | 'hr-HR' | 'cs-CZ' | 'da-DK' | 'nl-NL' | 'nl-BE' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-GH' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-KE' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TZ' | 'en-US' | 'en-ZA' | 'et-EE' | 'fil-PH' | 'fi-FI' | 'fr-BE' | 'fr-CA' | 'fr-CH' | 'fr-FR' | 'gl-ES' | 'ka-GE' | 'de-AT' | 'de-CH' | 'de-DE' | 'el-GR' | 'gu-IN' | 'he-IL' | 'hi-IN' | 'hu-HU' | 'is-IS' | 'id-ID' | 'ga-IE' | 'it-CH' | 'it-IT' | 'ja-JP' | 'jv-ID' | 'kn-IN' | 'kk-KZ' | 'km-KH' | 'ko-KR' | 'lo-LA' | 'lv-LV' | 'lt-LT' | 'mk-MK' | 'ms-MY' | 'ml-IN' | 'mt-MT' | 'mr-IN' | 'mn-MN' | 'ne-NP' | 'no-NO' | 'fa-IR' | 'pl-PL' | 'pt-PT' | 'pt-BR' | 'pa-Guru-IN' | 'ro-RO' | 'ru-RU' | 'sr-RS' | 'si-LK' | 'sk-SK' | 'sl-SI' | 'es-BO' | 'es-AR' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'su-ID' | 'sw-TZ' | 'sw-KE' | 'sv-SE' | 'ta-IN' | 'ta-LK' | 'ta-MY' | 'ta-SG' | 'te-IN' | 'th-TH' | 'tr-TR' | 'uk-UA' | 'ur-IN' | 'ur-PK' | 'uz-UZ' | 'vi-VN' | 'zu-ZA' required
timeoutinteger required

The maximum duration of speech capture.

maxSilenceinteger

The silence duration before terminating the speech capture after speech has been detected.

keyPhrasesstring[]

Array of key-phrases used for matching capturing speech.

terminateOnKeyPhraseboolean

Indicates whether speech capture should terminate immediately upon detecting a key phrase. Defaults to true. When false, capture proceeds until completion and retains only the first matched key phrase, if any.

customDictionarystring[]

Array of custom words (typically, industry-specific terms) used for improved speech capture.

advancedFormattingboolean

Toggles enhanced text formatting features like punctuation, proper casing, numeral normalization, and disfluency filtering. Defaults to false.

provider'GOOGLE' | 'AZURE'

Speech-to-text provider to use. Defaults to GOOGLE.

Response

Success

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

Action status.

Changes

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