Transcribe Recording Begin

This System tool uses HTTPS (SSL) to securely send voicemail over the Internet to a service provider, such as Yap, who will attempt to accurately decode the message using natural speech processing. The resulting transcription is then returned to be inserted into the voicemail message using the Transcribe Recording Result tool.

Note: Voicemail transcription is a separately licensed add-on feature.

Inputs

Request URL

The URL provided by the transcription service provider, typically something like:

https://www.myVTservice.com

Request Options

An optional parameter used to provide the transcription service with optional request values. This parameter does not normally need to be set and handlers use a null value by default.

Note: This parameter is for future use.

Certificate

A certificate of authenticity provided by the service provider and consisting of a string of hexadecimal characters.

User ID

Identifies individual users or accounts for billing purposes. If a billing system is being used, this parameter is required for each transaction.

Speaker ID

Identifies the speaker and is used to track model adaptations for unique speakers to improve the accuracy of transcriptions. Use this parameter only if speakers can be reliably differentiated.

Note: You can have multiple, unique Speaker ID values for a particular User ID.

Filter Set

Provides the service provider with a context for the type of message. This parameter does not normally need to be set, but depends on the service provider and scenario. Your service provider might require values that are different from the ones listed below.

Value	Comment	Removes Pauses?	Replaces spelled numbers with digits?	Inserts limited punctuation?	Inserts commands and periods?	Replaces profanities with asterisks?
"none"	The default value if no filter set is specified. Results are returned with no presentation reformatting.	No	No	No	No	No
vm3 (voicemail 3)		Yes	Yes	Yes	No	Yes
vm4 (voicemail 4)	Recommended for voicemail to text applications. This is the default value if an empty string is used.	Yes	Yes	No	Yes	Yes
ff2 (freeform 2)		Yes	Yes	No	No	Yes

Note: If no value (an empty string)  is passed, the tool uses the vm4 filter set.

Recording ID

The unique ID assigned to the recording.

Recording File

The name of the file that contains the recording.

Note: If both the recording ID and Recording File parameters are specified, the tool uses Recording ID.

Detailed Results

Attribute (True or False) that turns on/off detailed results from the transcription request. Handlers default to False. When set to True, detailed results will appear in the voicemail message body of the transcription. A value other than True or False is interpreted as False.

Timeout (sec)

Set to 45 seconds as the default, this value is used as a threshold for abandoning a transcription request. A voicemail is sent only after a transcription request has returned or the abandon threshold has been reached. The delay is added to any delay in voicemail delivery that may have existed prior to the activation of this feature. This value can be modified to meet specific needs, but keep in mind that using a smaller timeout value increases chances of a request being abandoned due to timeout.

Outputs

Transcription Cookie

A code identifying the transcription job as a referenced, counted handler object.

Note: The job is discarded if the object goes out of scope.

Transcription Cookie String

A string that refers to the object.

Exit Code

An Exit Code (iExitCode) of 0 (zero) indicates success and a non-zero code indicates an error or other condition about the results of this tool step.

Exit Text

The exit text string (sExitText) corresponds to the Exit Code. When the Exit Code is 0, the Exit Text is "Success."

Exit Paths

Success

This step takes the Success exit path if the voicemail was successfully sent to the transcription service.

Failure

This step takes the Failure exit path if the voicemail was not successfully sent.