getSpeech

The GetSpeech command has completed and its actionUrl is being invoked. A PerCL response is expected.

Request Parameter

Type

Description

requestType

string

Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked.

callId

string

Unique identifier for this Call, generated by FreeClimb.

accountId

string

Account ID associated with your account.

from

string

Phone number of the party that initiated the Call (in E.164 format).

to

string

Phone number provisioned to the customer and to which this Call is directed (in E.164 format).

callStatus

string

Descriptive status for the Call. Valid values are:
ringing - Call is currently ringing.
inProgress - Call was answered and is currently in progress (not queued, not in conference).
completed - Call ended normally.
busy - Caller received a busy signal.
failed - Call could not be completed as dialed (most likely because the phone number was non-existent).
noAnswer - Call ended without being answered.
canceled - Call was canceled via the REST API while queued or ringing.

direction

string

String describing the direction of the Call – inbound for inbound calls, outbound for calls initiated via the REST API, or outboundDial for calls initiated by the OutDial PerCL command.

conferenceId

string

This is only populated if request pertains to a conference. Otherwise, it is set to null.

queueId

string

This is only populated if the request pertains to a queue. Otherwise, it is set to null.

reason

string

This field explains how the GetSpeech action ended. Valid values are:
error - the speech recognition engine failed to process the request for any reason (e.g. invalid grammar file).
hangup - the Caller hung up.
digit - the Caller input a digit during recognition.
noInput - an initial timeout occurred.
noMatch - there was audio input but it could not be matched with the grammar.
recognition - the audio input matched the specified grammar to some degree of confidence.
recognitionTimeout - The recognition timed out while waiting for speech based on grammars specified

recognitionResult

string or integer

Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by "xxxxx" when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit.

confidence

integer

Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition.

parentCallId

string

ID of the Call that created this leg (child call).

completionReason

string

Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition.

completionCause

string

Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition.

mrcpCode

integer

Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.

mrcpDiagnostic

string

Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.