Azure.Communication.CallAutomation Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AddParticipantEventResult |
AddParticipantEventResult is returned from WaitForEvent of AddParticipantResult. |
| AddParticipantFailed |
The add participant failed event. |
| AddParticipantOptions |
The add participants operation options. |
| AddParticipantResult |
AddParticipantsResult Result. |
| AddParticipantSucceeded |
The add participants succeeded event. |
| AnswerCallEventResult |
AnswerCallEventResult is returned from WaitForEvent of AnswerCallResult. |
| AnswerCallOptions |
The answer call operation options. |
| AnswerCallResult |
The result from creating a call. |
| AnswerFailed |
The failed to answer call event. |
| AudioData |
Streaming Audio. |
| AudioMetadata |
Metadata for Audio Streaming. |
| CallAutomationClient |
The Azure Communication Services Call Automation client. |
| CallAutomationClientOptions |
The latest version of the Call Automation. |
| CallAutomationEventBase |
The CallAutomation Event Data. |
| CallAutomationEventParser |
Helper class for parsing Acs call back events. |
| CallAutomationEventProcessor |
Call Automation's EventProcessor for incoming events for ease of use. |
| CallAutomationModelFactory |
Model factory for models. |
| CallConnected |
The call connected event. |
| CallConnection |
The Azure Communication Services Call Connection Client. |
| CallConnectionProperties |
The call connection properties. |
| CallDisconnected |
The call disconnected event. |
| CallIntelligenceOptions |
AI options for the call. |
| CallInvite |
Call invitee details. |
| CallLocator |
Represents a locator for a call in Azure Communication Services, that can be handled by the Call Automation APIs |
| CallMedia |
The Azure Communication Services Call Media Client. |
| CallMediaRecognizeChoiceOptions |
The Recognize configurations specific for IVR Choices. |
| CallMediaRecognizeDtmfOptions |
The Recognize configurations specific for Dtmf. |
| CallMediaRecognizeOptions |
The Call Media Recognize Options. |
| CallMediaRecognizeSpeechOptions |
The Recognize configurations specific for IVR Continuouse Speech Recognition. |
| CallMediaRecognizeSpeechOrDtmfOptions |
The Recognize configurations specific for IVR Continuouse Speech Recognition. |
| CallParticipant |
The participant in a call. |
| CallRecording |
The Azure Communication Services Call Recording client. |
| CallTransferAccepted |
The call transfer accepted event. |
| CallTransferFailed |
The call transfer failed event. |
| CancelAddParticipantEventResult |
CancelAddParticipantEventResult is returned from WaitForEvent of CancelAddParticipantOperationResult. |
| CancelAddParticipantFailed |
The cancel add participant failed event. |
| CancelAddParticipantOperationOptions |
The cancel add participant operation options. |
| CancelAddParticipantOperationResult |
AddParticipantsResult Result. |
| CancelAddParticipantSucceeded |
The add participant cancelled event. |
| CancelAllMediaOperationsEventResult |
CancelAllMediaOperationsEventResult is returned from WaitForEvent of CancelAllMediaOperationsResult. |
| CancelAllMediaOperationsResult |
The result from Canceling all media operation. |
| ChannelAffinity |
Channel affinity for a participant. |
| ChoiceResult |
The ChoiceResult. |
| ConnectCallEventResult |
ConnectCallEventResult is returned from WaitForEvent of ConnectCallResult. |
| ConnectCallOptions |
Options for creating a call. |
| ConnectCallResult |
The result from connect request. |
| ConnectFailed |
The ConnectFailed event. |
| ContinuousDtmfRecognitionOptions |
The ContinuousDtmfRecognitionOptions operation options. |
| ContinuousDtmfRecognitionStopped |
The ContinuousDtmfRecognitionStopped. |
| ContinuousDtmfRecognitionToneFailed |
The ContinuousDtmfRecognitionToneFailed. |
| ContinuousDtmfRecognitionToneReceived |
The ContinuousDtmfRecognitionToneReceived. |
| CreateCallEventResult |
CreateCallEventResult is returned from WaitForEvent of CreateCallResult. |
| CreateCallFailed |
The create call failed event. |
| CreateCallOptions |
Options for the Create Call Request. |
| CreateCallResult |
The result from creating a call. |
| CreateGroupCallOptions |
Options for the Create Call Request. |
| CustomCallingContext |
CustomCallingContext details. |
| DtmfData |
Streaming dtmf data. |
| DtmfResult |
The DtmfResult. |
| FileSource |
The File Source. |
| GroupCallLocator |
The group call locator. |
| HoldEventResult |
HoldEventResult is returned from WaitForEvent of HoldResult. |
| HoldFailed |
The Hold Failed event. |
| HoldOptions |
Options for the Hold Request. |
| HoldResult |
The result from playing audio. |
| MediaStreamingFailed |
The MediaStreamingFailed. |
| MediaStreamingOptions |
The MediaStreamingOptions. |
| MediaStreamingStarted |
The MediaStreamingStarted. |
| MediaStreamingStopped |
The MediaStreamingStopped. |
| MediaStreamingSubscription |
The MediaStreamingSubscription. |
| MediaStreamingUpdate |
The MediaStreamingUpdate. |
| MoveParticipantEventResult |
MoveParticipantEventResult is returned from WaitForEvent of MoveParticipantsResult. |
| MoveParticipantFailed |
The Move participant failed event. |
| MoveParticipantsOptions |
The move participants operation options. |
| MoveParticipantsResult |
MoveParticipantsResult Result. |
| MoveParticipantSucceeded |
The Move participant succeeded event. |
| MuteParticipantOptions |
Options for the Mute Participant Request. |
| MuteParticipantResult |
The result payload for muting participants from the call. |
| OutStreamingData |
Base class for Out Streaming Data |
| ParticipantsUpdated |
The participants updated event. |
| PiiRedactionOptions |
PII redaction configuration options. |
| PlayCanceled |
The PlayCanceled. |
| PlayCompleted |
The play completed event. |
| PlayEventResult |
PlayEventResult is returned from WaitForEvent of PlayResult. |
| PlayFailed |
The Play Failed event. |
| PlayOptions |
Options to be used in the Play operation. |
| PlayResult |
The result from playing audio. |
| PlaySource |
The PlaySource. |
| PlayStarted |
Play started event. |
| PlayToAllOptions |
Options to be used in the PlayToAll operation. |
| RecognitionChoice |
The Choice. |
| RecognizeCanceled |
The RecognizeCanceled. |
| RecognizeCompleted |
Recognize completed event. |
| RecognizeFailed |
The Recognize failed event. |
| RecognizeResult |
The Recognize result which could be tone or choice result. |
| RecordingStateChanged |
The RecordingStateChanged. |
| RecordingStateResult |
The RecordingStateResponse. |
| RecordingStorage |
Recording Storage base |
| RedirectCallOptions |
The redirect call operation options. |
| RejectCallOptions |
The reject call operation options. |
| RemoveParticipantEventResult |
RemoveParticipantEventResult is returned from WaitForEvent of RemoveParticipantResult. |
| RemoveParticipantFailed |
The remove participant failed event. |
| RemoveParticipantOptions |
Options for the Remove Participants Request. |
| RemoveParticipantResult |
RemoveParticipantResult Result. |
| RemoveParticipantSucceeded |
The remove participant succeeded event. |
| ResultInformation |
The ResultInformation. |
| RoomCallLocator |
The room call locator. |
| SendDtmfTonesCompleted |
The SendDtmfTonesCompleted event. |
| SendDtmfTonesEventResult |
SendDtmfTonesEventResult is returned from WaitForEvent of SendDtmfTonesResult. |
| SendDtmfTonesFailed |
The SendDtmfFailed event. |
| SendDtmfTonesOptions |
The SendDtmfTonesOptions operation options. |
| SendDtmfTonesResult |
The SendDtmfTonesResult. |
| SentimentAnalysisResult |
The SentimentAnalysisResult. |
| ServerCallLocator |
The server call locator. |
| SipDiagnosticInfo |
The SipDiagnosticInfo. |
| SpeechResult |
The speech status as a result. |
| SsmlSource |
The SsmlSource. |
| StartMediaStreamingOptions |
Options for the Start Media Streaming Request. |
| StartRecognizingCallMediaResult |
The result from start recognizing result. |
| StartRecognizingEventResult |
StartRecognizingEventResult is returned from WaitForEvent of StartRecognizingCallMediaResult. |
| StartRecordingFailed |
The StartRecordingFailed. |
| StartRecordingOptions |
Options for the Start Recording operation. |
| StartTranscriptionOptions |
Options for the Start transcription Request. |
| StopAudio |
Stop Streaming Audio. |
| StopMediaStreamingOptions |
Options for the Stop Media Streaming Request. |
| StopTranscriptionOptions |
Options for the stop transcription Request. |
| StreamingData |
Base class for Streaming Data |
| SummarizationOptions |
Configuration options for call summarization. |
| SummarizeCallOptions |
Options for summarizing a call. |
| TeamsPhoneCallDetails |
TeamsPhoneCallDetails. |
| TeamsPhoneCallerDetails |
TeamsPhoneCallerDetails. |
| TeamsPhoneSourceDetails |
TeamsPhoneSourceDetails. |
| TextSource |
The TextSource. |
| TranscriptionCallSummaryUpdated |
The TranscriptionCallSummaryUpdated. |
| TranscriptionData |
Streaming Transcription. |
| TranscriptionFailed |
The TranscriptionFailed. |
| TranscriptionMetadata |
Metadata for Transcription Streaming. |
| TranscriptionOptions |
Options of live transcription. |
| TranscriptionStarted |
The TranscriptionStarted. |
| TranscriptionStopped |
The TranscriptionStopped. |
| TranscriptionSubscription |
The TranscriptionSubscription. |
| TranscriptionUpdate |
The TranscriptionUpdate. |
| TranscriptionUpdated |
The TranscriptionUpdated. |
| TransferCallToParticipantEventResult |
TransferCallToParticipantEventResult is returned from WaitForEvent of TransferCallToParticipantResult. |
| TransferCallToParticipantResult |
The response payload for transferring the call. |
| TransferToParticipantOptions |
The transfer call to participant operation options. |
| UnholdOptions |
Options for the Hold Request. |
| UpdateTranscriptionOptions |
Options for the stop transcription Request. |
| WordData |
The result for each word of the phrase |
Structs
| Name | Description |
|---|---|
| AudioFormat |
The audio format used for encoding, including sample rate and channel type. The default is Pcm16KMono. |
| CallConnectionState |
The state of the call connection. |
| CallMediaRecognitionType |
Determines the sub-type of the recognize operation. In case of cancel operation the this field is not set and is returned empty |
| CallRejectReason |
The rejection reason. |
| ContentTransferOptions |
ContentTransferOptions is used to provide options for parallel transfers. |
| DtmfTone |
The Tone. |
| MediaEventReasonCode |
Reason Codes for incoming webhook events. |
| MediaStreamingAudioChannel |
The audio channel type to stream, e.g., unmixed audio, mixed audio. |
| MediaStreamingContent |
The MediaStreamingContentType. |
| MediaStreamingStatus |
The MediaStreamingStatus. |
| MediaStreamingStatusDetails |
The MediaStreamingStatusDetails. |
| MediaStreamingSubscriptionState |
Media streaming subscription state. |
| RecognizeInputType |
Determines the type of the recognition. |
| RecognizeResultType |
Determines the sub-type of the recognize result. |
| RecordingChannel |
The channel type of call recording. |
| RecordingContent |
The content type of call recording. |
| RecordingFormat |
The format type of call recording. |
| RecordingKind |
The RecordingKind. |
| RecordingState |
The RecordingState. |
| RecordingStorageKind |
Defines the kind of external storage. |
| RedactionType |
Value indicating the PII redaction type to be used. |
| StreamingTransport |
Defines the transport type used for streaming. Note that future values may be introduced that are not currently documented. |
| TranscriptionResultState |
The TranscriptionResultType. |
| TranscriptionStatus |
The TranscriptionStatus. |
| TranscriptionStatusDetails |
The TranscriptionStatusDetails. |
| TranscriptionSubscriptionState |
Transcription subscription state. |
| VoiceKind |
Voice kind type. |
Enums
| Name | Description |
|---|---|
| AudioChannel |
Specifies the Audio Channels |
| CallAutomationClientOptions.ServiceVersion |
The CallAutomation service version. |
| MediaKind |
Messages sent from websocket server |
| SipHeaderPrefix |
Add commentMore actions Enum representing the prefix to be used for SIP X headers. |
| StreamingDataKind |
Kind of streaming data when websocket receives the data |
