@azure/communication-call-automation package

Classes

CallAutomationClient	A CallAutomationClient represents a Client to the Azure Communication CallAutomation service.
CallConnection	CallConnection class represents call connection based APIs.
CallMedia	CallMedia class represents call media related APIs.
CallRecording	CallRecording class represents call recording related APIs.
StreamingData	Class to handle the parsing of incoming streaming data.

Interfaces

AddParticipantFailed	The failed to add participant event.
AddParticipantOptions	Options to add participants.
AddParticipantResult	The response payload for adding participants to the call.
AddParticipantSucceeded	The participant successfully added event.
AnswerCallOptions	Options to answer a call.
AnswerFailed
AudioData	Audio streaming data.
AudioMetadata	Audio streaming metadata.
CallAutomationClientOptions	Client options used to configure CallAutomation Client API requests.
CallConnected	Event when call was established.
CallConnectionProperties	Properties of a call connection
CallDisconnected	Event when all participants left and call was terminated.
CallIntelligenceOptions	AI options for the call.
CallInvite	Call invitee details.
CallLocator	The locator used for joining or taking action on a call.
CallMediaRecognizeChoiceOptions	The recognize configuration specific to Choices.
CallMediaRecognizeDtmfOptions	The recognize configuration specific to Dtmf.
CallMediaRecognizeOptions	Options to configure the recognize operation.
CallMediaRecognizeSpeechOptions	The recognize configuration specific to Speech.
CallMediaRecognizeSpeechOrDtmfOptions	The recognize configuration for Speech or Dtmf
CallParticipant	Contract model of an ACS call participant
CallResult	The interface used as parent of [action]CallResult
CallTransferAccepted	Event when transfer request was successful.
CallTransferFailed	Event when transfer request was failed.
CancelAddParticipantFailed	The failed to cancel add participant event.
CancelAddParticipantOperationOptions	Options for cancelling add participant request.
CancelAddParticipantOperationResult	The response payload for cancelling add participant request.
CancelAddParticipantSucceeded	Successful cancel add participant event.
ChannelAffinity	Channel affinity for a participant
ChoiceResult
ConnectCallOptions	Options to Connect request.
ConnectFailed
ContinuousDtmfRecognitionOptions	Options to continuous Dtmf recognition.
ContinuousDtmfRecognitionStopped	Event sent when continuous Dtmf recognition stopped.
ContinuousDtmfRecognitionToneFailed	Event sent when failed to recognize continuous Dtmf tone.
ContinuousDtmfRecognitionToneReceived	Event sent when Dtmf tone received from targeted participant in call.
CreateCallFailed
CreateCallOptions	Options to create a call.
DownloadRecordingOptions	Options to download recording.
DtmfData	Dtmf streaming data.
DtmfResult
FileSource	The FileSource model.
HoldFailed
HoldOptions	Options to hold participant.
ListParticipantsResult	The response payload for getting participants of the call.
MediaStreamingFailed
MediaStreamingOptions	Options for media streaming.
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	Options to mute participant.
MuteParticipantResult	The response payload for muting participant from the call.
OutStreamingData	OutboundStreamingAudioData interface for outbound audio streaming payload.
ParticipantsUpdated	Event when there was an update to participant(s).
PlayCanceled	Event when Media play was canceled by Cancel operation.
PlayCompleted	Event when Media play was successfully completed.
PlayFailed	Event when Media play was failed.
PlayOptions	Options to play audio.
PlaySource	The PlaySource model.
PlayStarted	Event when Media play was successfully started.
PlayToAllOptions	Options to playToAll audio.
RecognitionChoice	A Recognition Choice
RecognizeCanceled	Event when Media recognize was canceled by Cancel operation.
RecognizeCompleted	Event when Media recognize was successfully completed.
RecognizeFailed	Event when Media recognize was failed.
RecordingStateChanged	Event when Recording state has been changed.
RecordingStateResult	The response payload for starting a call recording or getting call recording state.
RecordingStorage	The recording storage
RejectCallOptions	Options to reject call.
RemoveParticipantFailed	The failed to remove participant event.
RemoveParticipantResult	The response payload for removing participants from the call.
RemoveParticipantSucceeded	The participant successfully removed event.
RemoveParticipantsOption	Options to remove participants.
RestAddParticipantFailed	The failed to add participants event.
RestAddParticipantSucceeded	The participants successfully added event.
RestAnswerFailed	The failed to answer call event.
RestCallConnected	The call connected event.
RestCallDisconnected	The call disconnected event.
RestCallTransferAccepted	The call transfer accepted event.
RestCallTransferFailed	The call transfer failed event.
RestCancelAddParticipantFailed	Failed cancel add participant event.
RestCancelAddParticipantSucceeded	Successful cancel add participant event.
RestConnectFailed	The ConnectFailed event.
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	The create call failed event.
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	The participants updated in a call event.
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	Play started event.
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	The failed to remove participant event.
RestRemoveParticipantSucceeded	The participant removed event.
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	Event sent when Dtmf tones send successfully.
SendDtmfTonesFailed	Event sent when Dtmf tones send failed.
SendDtmfTonesOptions	Options to send Dtmf tones.
SendDtmfTonesResult	The response payload for sending DTMF tones.
SipCustomHeader	SIP Custom header.
SipUserToUserHeader	SIP User To User header.
SpeechResult	The speech status as a result.
SsmlSource	The SsmlSource model.
StartMediaStreamingOptions	Options for start media streaming request.
StartRecordingFailed	Event when StartRecording was failed.
StartRecordingOptions	Options to get a start a recording.
StartTranscriptionOptions	Options to start transcription
StopAudio
StopMediaStreamingOptions	Options for stop media streaming request.
StopTranscriptionOptions	Options to stop transcription
TextSource	The TextSource model.
TranscriptionData	Streaming Transcription.
TranscriptionFailed
TranscriptionMetadata	Metadata for Transcription Streaming.
TranscriptionOptions	Options for media streaming.
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	The response payload for transferring the call.
TransferCallToParticipantOptions	Options to transfer participants.
UnholdOptions	Options to Unhold participant.
UpdateTranscriptionOptions	Options to update transcription
VoipHeader	VOIP header.
WordData	Text in the phrase.

Type Aliases

AnswerCallResult	AnswerCall result
AudioFormat	Defines values for AudioFormat. <xref:KnownAudioFormat> can be used interchangeably with AudioFormat, this enum contains the known values that the service supports. Known values supported by the service pcm16KMono pcm24KMono
CallAutomationEvent	Callback events for Call Automation
CallConnectionStateModel	Defines values for CallConnectionStateModel. <xref:KnownCallConnectionStateModel> can be used interchangeably with CallConnectionStateModel, this enum contains the known values that the service supports. Known values supported by the service unknown connecting connected transferring transferAccepted disconnecting disconnected
CallLocatorType	The locator type of a call.
CallRejectReason	Defines values for CallRejectReason. KnownCallRejectReason can be used interchangeably with CallRejectReason, this enum contains the known values that the service supports. Known values supported by the service none busy forbidden
ConnectCallResult	ConnectCall result
CreateCallResult	CreateCall result
CustomCallingContext	Custom Calling Context
DeleteRecordingOptions	Options to delete recording.
GetCallConnectionPropertiesOptions	Options to get call connection properties.
GetParticipantOptions	Options to get a participant.
GetRecordingPropertiesOptions	Options to get recording properties.
HangUpOptions	Options to hang up the call
MediaKind	Streaming media kind.
MediaStreamingAudioChannelType	Defines values for MediaStreamingAudioChannelType. KnownMediaStreamingAudioChannelType can be used interchangeably with MediaStreamingAudioChannelType, this enum contains the known values that the service supports. Known values supported by the service mixed unmixed
MediaStreamingContentType	Defines values for MediaStreamingContentType. KnownMediaStreamingContentType can be used interchangeably with MediaStreamingContentType, this enum contains the known values that the service supports. Known values supported by the service audio
PauseRecordingOptions	Options to get a pause a recording.
RecognitionType	Defines values for RecognitionType. <xref:KnownRecognitionType> can be used interchangeably with RecognitionType, this enum contains the known values that the service supports. Known values supported by the service dtmf speech choices
RecordingChannel	The channel type of a call recording.
RecordingContent	The content type of a call recording.
RecordingFormat	The format type of a call recording.
RecordingKind	The format type of a call recording.
RecordingState	Defines values for RecordingState. <xref:KnownRecordingState> can be used interchangeably with RecordingState, this enum contains the known values that the service supports. Known values supported by the service active inactive
RecordingStorageKind	The storage type of a call recording.
RedirectCallOptions	Options to redirect call.
ResumeRecordingOptions	Options to resume recording.
SipHeaderPrefix	The type of the Sip header prefix.
StopRecordingOptions	Options to get a stop a recording.
StreamingDataKind
StreamingDataResult
Tone	Defines values for Tone. <xref:KnownTone> can be used interchangeably with Tone, this enum contains the known values that the service supports. Known values supported by the service zero one two three four five six seven eight nine a b c d pound asterisk

Enums

Channel
DtmfTone	A Dtmf Tone.
KnownCallRejectReason	Known values of CallRejectReason that the service accepts.
KnownMediaStreamingAudioChannelType	Known values of MediaStreamingAudioChannelType that the service accepts.
KnownMediaStreamingContentType	Known values of MediaStreamingContentType that the service accepts.
KnownStreamingTransportType	Known values of KnownStreamingTransportType that the service accepts.
RecognizeInputType	The type of the recognition that the service accepts.
VoiceKind	Defines values for VoiceKind that the service accepts.

Functions

createOutboundAudioData(string)	Helper function to create outbound audio data payload.
createOutboundStopAudioData()	Helper function to create outbound stop audio data payload.
parseCallAutomationEvent(string | Record<string, unknown>)	Helper function for parsing Acs callback events.

Function Details

createOutboundAudioData(string)

Helper function to create outbound audio data payload.

function createOutboundAudioData(data: string): string

Parameters

data

string

Returns

string

createOutboundStopAudioData()

Helper function to create outbound stop audio data payload.

function createOutboundStopAudioData(): string

Returns

string

parseCallAutomationEvent(string | Record<string, unknown>)

Helper function for parsing Acs callback events.

function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent

Parameters

encodedEvents

string | Record<string, unknown>

Returns

CallAutomationEvent