RestRecognizeCompleted interface

Package:

@azure/communication-call-automation

Properties

callConnectionId	Call connection ID.
choiceResult	Defines the result for RecognitionType = Choices
correlationId	Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
dtmfResult	Defines the result for RecognitionType = Dtmf
operationContext	Used by customers when calling mid-call actions to correlate the request to the response event.
recognitionType	Determines the sub-type of the recognize operation. In case of cancel operation the this field is not set and is returned empty
resultInformation	Contains the resulting SIP code, sub-code and message.
serverCallId	Server call ID.
speechResult	Defines the result for RecognitionType = Speech and SpeechOrDtmf NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

callConnectionId

Call connection ID.

callConnectionId?: string

Property Value

string

choiceResult

Defines the result for RecognitionType = Choices

choiceResult?: ChoiceResult

Property Value

ChoiceResult

correlationId

Correlation ID for event to call correlation. Also called ChainId for skype chain ID.

correlationId?: string

Property Value

string

dtmfResult

Defines the result for RecognitionType = Dtmf

dtmfResult?: DtmfResult

Property Value

DtmfResult

operationContext

Used by customers when calling mid-call actions to correlate the request to the response event.

operationContext?: string

Property Value

string

recognitionType

Determines the sub-type of the recognize operation. In case of cancel operation the this field is not set and is returned empty

recognitionType?: string

Property Value

string

resultInformation

Contains the resulting SIP code, sub-code and message.

resultInformation?: ResultInformation

Property Value

RestResultInformation

serverCallId

Server call ID.

serverCallId?: string

Property Value

string

speechResult

Defines the result for RecognitionType = Speech and SpeechOrDtmf NOTE: This property will not be serialized. It can only be populated by the server.

speechResult?: SpeechResult

Property Value

SpeechResult