TranscribeUtterance

The TranscribeUtterance command transcribes the caller’s voice, returns transcription of the audio and, optionally, returns the recording of the audio transcribed.

TranscribeUtterance is a blocking and terminal command. As such, the actionUrl property is required in the command. Control of the Call picks up using the PerCL provided by the user in response to the result posted to the actionUrl. Recording and Transcription information is returned in the actionUrl post. If the reason this command ended was due to the call hanging up, any PerCL provided in response will not execute.

Nesting Rules

The following actions may be within the TranscribeUtterance command.

Say
Play
Pause

The commands are not directly nested but are contained in the prompts attribute as a list of commands. See example below. The nested commands (Say, Play, and Pause) will have Barge-In enabled.

The TranscribeUtterance command cannot be nested within any other command.

Note that nested commands do not inherit the value of privacyMode from the parent command's specified values for privacyForLogging or privacyForRecording. To use privacyMode in any nested command, it must be specified within that command's parameters.

Example

[
    {
        "TranscribeUtterance": {
            "actionUrl": "http://foo.com/handleTranscription",
            "record" : {
                "maxLengthSec" : 15,
                "saveRecording" : true,
                "rcrdTerminationSilenceTimeMs" : 2000
            },
            "playBeep": true,
            "prompts": [
                {
                    "Say": {
                        "text" : "Please leave a message after the beep."
                    }
                }
            ]
        }
    }
]

Command Attributes

TranscribeUtterance supports the following attributes that modify its behavior:

Type: absolute URL

URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.

Type: boolean
Default: false

Type: boolean
Default: false

Type: boolean
Default: false

Type: Array
Default: null

Usage notes

Command Completion

Whenever record/transcribe combinations are specified, whichever action takes the longest will determine when the callback is invoked. There will be only one callback with the results from any/all of the options chosen. Total timeout for this command will be the maximum value of the maxLengthSec parameter (15 sec).

Privacy/PCI Compliance

If a recording is generated, this recording will only be available for download for 2 minutes prior to deletion. It also cannot be used as a parameter for a Play command.

It's important to note that privacy flags are set at the command level, if Play, Say, or Pause specify privacy flags, these will be used instead of the TranscribeUtterance privacy flags.