@azure/communication-call-automation package

類別

CallAutomationClient	CallAutomationClient 代表 Azure 通訊 CallAutomation 服務的用戶端。
CallConnection	CallConnection 類別代表呼叫連線型 API。
CallMedia	CallMedia 類別代表呼叫媒體相關的 API。
CallRecording	CallRecording 類別代表通話錄製相關的 API。
StreamingData	類來處理傳入流數據的解析。

介面

AddParticipantFailed	無法新增參與者事件。
AddParticipantOptions	新增參與者的選項。
AddParticipantResult	將參與者新增至呼叫的響應承載。
AddParticipantSucceeded	參與者已成功新增事件。
AnswerCallOptions	接聽通話的選項。
AnswerFailed
AudioData	音訊串流數據。
AudioMetadata	音訊串流元數據。
CallAutomationClientOptions	用來設定 CallAutomation 用戶端 API 要求的客戶端選項。
CallConnected	建立呼叫時的事件。
CallConnectionProperties	呼叫連線的屬性
CallDisconnected	當所有參與者離開並呼叫終止時，就會發生事件。
CallIntelligenceOptions	呼叫的 AI 選項。
CallInvite	呼叫受邀者詳細數據。
CallLocator	用於在通話上聯結或採取動作的定位器。
CallMediaRecognizeChoiceOptions	[選擇] 特有的辨識組態。
CallMediaRecognizeDtmfOptions	Dtmf 特有的辨識組態。
CallMediaRecognizeOptions	設定辨識作業的選項。
CallMediaRecognizeSpeechOptions	語音特有的辨識組態。
CallMediaRecognizeSpeechOrDtmfOptions	語音或 Dtmf 的辨識組態
CallParticipant	ACS 通話參與者的合約模型
CallResult	用作 [action]CallResult 的父級的介面
CallTransferAccepted	傳輸要求成功時的事件。
CallTransferFailed	傳輸要求失敗時的事件。
CancelAddParticipantFailed	無法取消新增參與者事件。
CancelAddParticipantOperationOptions	取消新增參與者要求的選項。
CancelAddParticipantOperationResult	取消新增參與者要求的響應承載。
CancelAddParticipantSucceeded	成功取消新增參與者事件。
ChannelAffinity	參與者的通道親和性
ChoiceResult
ConnectCallOptions	線上要求的選項。
ConnectFailed
ContinuousDtmfRecognitionOptions	連續 Dtmf 辨識的選項。
ContinuousDtmfRecognitionStopped	連續 Dtmf 辨識停止時傳送的事件。
ContinuousDtmfRecognitionToneFailed	無法辨識連續 Dtmf 音調時傳送的事件。
ContinuousDtmfRecognitionToneReceived	從通話中目標參與者收到 Dtmf 音調時傳送的事件。
CreateCallFailed
CreateCallOptions	建立呼叫的選項。
DownloadRecordingOptions	下載錄製的選項。
DtmfData	Dtmf 流數據。
DtmfResult
FileSource	FileSource 模型。
HoldFailed
HoldOptions	保留參與者的選項。
ListParticipantsResult	取得通話參與者的響應承載。
MediaStreamingFailed
MediaStreamingOptions	媒體流選項。
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	將參與者設為靜音的選項。
MuteParticipantResult	將參與者從通話中靜音的響應承載。
OutStreamingData	OutboundStreamingAudioData 介面。
ParticipantsUpdated	當參與者有更新時的事件。
PlayCanceled	取消作業取消媒體播放時的事件。
PlayCompleted	媒體播放成功完成時的事件。
PlayFailed	媒體播放失敗時的事件。
PlayOptions	播放音訊的選項。
PlaySource	PlaySource 模型。
PlayStarted	成功啟動媒體播放時的事件。
PlayToAllOptions	PlayToAll 音訊的選項。
RecognitionChoice	辨識選擇
RecognizeCanceled	取消作業取消媒體辨識時的事件。
RecognizeCompleted	媒體辨識成功完成時的事件。
RecognizeFailed	媒體辨識失敗時的事件。
RecordingStateChanged	已變更錄製狀態時的事件。
RecordingStateResult	啟動通話錄製或取得通話錄製狀態的響應承載。
RecordingStorage	錄製記憶體
RejectCallOptions	拒絕通話的選項。
RemoveParticipantFailed	無法移除參與者事件。
RemoveParticipantResult	從呼叫中移除參與者的響應承載。
RemoveParticipantSucceeded	參與者已成功移除事件。
RemoveParticipantsOption	拿掉參與者的選項。
RestAddParticipantFailed	無法新增參與者事件。
RestAddParticipantSucceeded	參與者已成功新增事件。
RestAnswerFailed	無法接聽通話事件。
RestCallConnected	呼叫連線事件。
RestCallDisconnected	已中斷連線的呼叫事件。
RestCallTransferAccepted	已接受呼叫傳輸的事件。
RestCallTransferFailed	呼叫轉移失敗事件。
RestCancelAddParticipantFailed	取消新增參與者事件失敗。
RestCancelAddParticipantSucceeded	成功取消新增參與者事件。
RestConnectFailed	ConnectFailed 事件。
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	建立呼叫失敗事件。
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	在呼叫事件中更新的參與者。
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	播放開始的活動。
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	無法移除參與者事件。
RestRemoveParticipantSucceeded	參與者已移除事件。
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	當 Dtmf 音調成功傳送時傳送的事件。
SendDtmfTonesFailed	Dtmf 音調傳送失敗時所傳送的事件。
SendDtmfTonesOptions	傳送 Dtmf 音調的選項。
SendDtmfTonesResult	傳送 DTMF 音調的響應承載。
SipCustomHeader	SIP 自定義標頭。
SipUserToUserHeader	SIP 使用者對用戶標頭。
SpeechResult	因此，語音狀態。
SsmlSource	SsmlSource 模型。
StartMediaStreamingOptions	啟動媒體串流要求的選項。
StartRecordingFailed	StartRecording 失敗時的事件。
StartRecordingOptions	開始錄製的選項。
StartTranscriptionOptions	開始轉譯的選項
StopAudio
StopMediaStreamingOptions	停止媒體串流要求的選項。
StopTranscriptionOptions	停止轉譯的選項
TextSource	TextSource 模型。
TranscriptionData	串流轉譯。
TranscriptionFailed
TranscriptionMetadata	轉譯數據流的元數據。
TranscriptionOptions	媒體流選項。
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	用於傳輸呼叫的響應承載。
TransferCallToParticipantOptions	傳送參與者的選項。
UnholdOptions	[未保留參與者] 的選項。
UpdateTranscriptionOptions	更新轉譯的選項
VoipHeader	VOIP 標頭。
WordData	片語中的文字。

類型別名

AnswerCallResult	AnswerCall 結果
AudioFormat	定義 AudioFormat 的值。 <xref:KnownAudioFormat> 可以與 AudioFormat 互換使用，此枚舉包含服務支援的已知值。 服務支援的已知值 pcm16K無 pcm24K無
CallAutomationEvent	呼叫自動化的回呼事件
CallConnectionStateModel	定義 CallConnectionStateModel 的值。 <xref:KnownCallConnectionStateModel> 可以與 CallConnectionStateModel 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 未知的 連線 連線 傳輸 transfer接受 中斷連線 中斷連線
CallLocatorType	呼叫的定位器類型。
CallRejectReason	定義 CallRejectReason 的值。 KnownCallRejectReason 可以與 CallRejectReason 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無 忙碌 禁止
ConnectCallResult	ConnectCall 結果
CreateCallResult	CreateCall 結果
CustomCallingContext	自訂呼叫內容
DeleteRecordingOptions	刪除錄製的選項。
GetCallConnectionPropertiesOptions	取得呼叫連線屬性的選項。
GetParticipantOptions	取得參與者的選項。
GetRecordingPropertiesOptions	取得錄製屬性的選項。
HangUpOptions	掛斷通話的選項
MediaKind	流媒體類型。
MediaStreamingAudioChannelType	定義 MediaStreamingAudioChannelType 的值。 KnownMediaStreamingAudioChannelType 可以與 MediaStreamingAudioChannelType 互換使用，此枚舉包含服務支援的已知值。 服務支援的已知值 混合 純
MediaStreamingContentType	定義 MediaStreamingContentType 的值。 KnownMediaStreamingContentType 可以與 MediaStreamingContentType 互換使用，此枚舉包含服務支援的已知值。 服務支援的已知值 音訊
PauseRecordingOptions	取得暫停錄製的選項。
RecognitionType	定義 RecognitionType 的值。 <xref:KnownRecognitionType> 可以與 RecognitionType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 DTMF 語音 選項
RecordingChannel	通話錄製的通道類型。
RecordingContent	通話錄製的內容類型。
RecordingFormat	通話錄製的格式類型。
RecordingKind	通話錄製的格式類型。
RecordingState	定義 RecordingState 的值。 <xref:KnownRecordingState> 可以與 RecordingState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用中 非使用中
RecordingStorageKind	通話錄製的儲存類型。
RedirectCallOptions	重新導向呼叫的選項。
ResumeRecordingOptions	繼續錄製的選項。
SipHeaderPrefix	Sip 標頭前置詞的類型。
StopRecordingOptions	取得停止錄製的選項。
StreamingDataKind
StreamingDataResult
Tone	定義 Tone 的值。 <xref:KnownTone> 可以與 Tone 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 零 一個 兩個 三個 四個 五個 六個 七個 八 九個 b c d 磅 星號

列舉

Channel
DtmfTone	Dtmf Tone。
KnownCallRejectReason	服務接受 CallRejectReason 的已知值。
KnownMediaStreamingAudioChannelType	服務接受的 MediaStreamingAudioChannelType 的已知值。
KnownMediaStreamingContentType	服務接受的 MediaStreamingContentType 的已知值。
KnownStreamingTransportType	服務的已知值 KnownStreamingTransportType。
RecognizeInputType	服務接受的辨識類型。
VoiceKind	定義服務接受的 VoiceKind 值。

函式

createOutboundAudioData(string)	用於創建出站音訊數據負載的 Helper 函數。
createOutboundStopAudioData()	用於創建出站停止音訊數據負載的輔助函數。
parseCallAutomationEvent(string | Record<string, unknown>)	剖析 Acs 回呼事件的協助程式函式。

函式詳細資料

createOutboundAudioData(string)

用於創建出站音訊數據負載的 Helper 函數。

function createOutboundAudioData(data: string): string

參數

data

string

傳回

string

createOutboundStopAudioData()

用於創建出站停止音訊數據負載的輔助函數。

function createOutboundStopAudioData(): string

傳回

string

parseCallAutomationEvent(string | Record<string, unknown>)

剖析 Acs 回呼事件的協助程式函式。

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

參數

encodedEvents

string | Record<string, unknown>

傳回

CallAutomationEvent