@azure/communication-call-automation package

类

CallAutomationClient	CallAutomationClient 表示 Azure Communication 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 音调。
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