Skip to main content
The transcribe verb generates real-time transcriptions of speech. This verb can be nested only within the following verbs:
When nested within a dial verb, transcribe provides long-running transcription of a phone call.
dial
{
  "verb": "dial",
  "actionHook": "dial",
  "callerId": "+491173331212",
  "answerOnBridge": true,
  "dtmfCapture": ["*2", "*3"],
  "dtmfHook": {
    "url": "/dtmf",
    "method": "GET"
  },
  "amd": {
    "actionHook": "amd",
    "recognizer": {
      "vendor": "microsoft",
      "language": "en-US"
    }
  },
  "transcribe": {
    "transcriptionHook": "http://example.com/transcribe",
    "recognizer": {
      "vendor": "Google",
      "language": "en-US",
      "interim": true
    }
  },
  "target": [
    {
      "type": "phone",
      "number": "+49XXXXXXXXXXX",
      "trunk": "Twilio"
    },
    {
      "type": "sip",
      "sipUri": "sip:[email protected]",
      "auth": {
        "username": "John",
        "password": "Doe"
      }
    },
    {
      "type": "user",
      "name": "[email protected]"
    }
  ]
}

Configuration

The full set of configuration parameters:
ParameterDescriptionRequired
transcriptionHookA webhook to receive an HTTP POST when a partial or final transcription is received from a provider.yes
recognizerSpeech recognition options.yes

More Information