RecognizeCompleted interface

Package:

@azure/communication-call-automation

Event when Media recognize was successfully completed.

Extends

Omit<RestRecognizeCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation">

Properties

callConnectionId	Call connection ID.
correlationId	Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
kind	kind of this event.
resultInformation	Contains the resulting SIP code/sub-code and message from NGC services.
serverCallId	Server call ID.

Inherited Properties

choiceResult	Defines the result for RecognitionType = Choices
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
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

correlationId

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

correlationId: string

Property Value

string

kind

kind of this event.

kind: "RecognizeCompleted"

Property Value

"RecognizeCompleted"

resultInformation

Contains the resulting SIP code/sub-code and message from NGC services.

resultInformation?: ResultInformation

Property Value

ResultInformation

serverCallId

Server call ID.

serverCallId: string

Property Value

string

Inherited Property Details

choiceResult

Defines the result for RecognitionType = Choices

choiceResult?: ChoiceResult

Property Value

ChoiceResult

Inherited From Omit.choiceResult

dtmfResult

Defines the result for RecognitionType = Dtmf

dtmfResult?: DtmfResult

Property Value

DtmfResult

Inherited From Omit.dtmfResult

operationContext

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

operationContext?: string

Property Value

string

Inherited From Omit.operationContext

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

Inherited From Omit.recognitionType

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

Inherited From Omit.speechResult