@azure/communication-call-automation package

Klasser

CallAutomationClient	En CallAutomationClient representerar en klient till Tjänsten Azure Communication CallAutomation.
CallConnection	Klassen CallConnection representerar samtalsanslutningsbaserade API:er.
CallMedia	Klassen CallMedia representerar samtalsmedierelaterade API:er.
CallRecording	Klassen CallRecording representerar samtalsinspelningsrelaterade API:er.
StreamingData	Klass för att hantera parsning av inkommande strömmande data.

Gränssnitt

AddParticipantFailed	Det gick inte att lägga till deltagarhändelsen.
AddParticipantOptions	Alternativ för att lägga till deltagare.
AddParticipantResult	Svarsnyttolasten för att lägga till deltagare i anropet.
AddParticipantSucceeded	Deltagaren har lagt till händelsen.
AnswerCallOptions	Alternativ för att besvara ett samtal.
AnswerFailed
AudioData	Strömmande ljuddata.
AudioMetadata	Metadata för ljudströmning.
CallAutomationClientOptions	Klientalternativ som används för att konfigurera Api-begäranden för CallAutomation-klienten.
CallConnected	Händelse när anropet upprättades.
CallConnectionProperties	Egenskaper för en samtalsanslutning
CallDisconnected	Händelse när alla deltagare lämnade och samtalet avbröts.
CallIntelligenceOptions	AI-alternativ för anropet.
CallInvite	Samtalsinbjudningsinformation.
CallLocator	Positioneraren som används för att ansluta eller vidta åtgärder vid ett anrop.
CallMediaRecognizeChoiceOptions	Konfigurationen för att identifiera som är specifik för Val.
CallMediaRecognizeDtmfOptions	Den identifiera konfiguration som är specifik för Dtmf.
CallMediaRecognizeOptions	Alternativ för att konfigurera identifieringsåtgärden.
CallMediaRecognizeSpeechOptions	Den identifiera konfiguration som är specifik för Speech.
CallMediaRecognizeSpeechOrDtmfOptions	Igenkänningskonfigurationen för Speech eller Dtmf
CallParticipant	Kontraktsmodell för en ACS-samtalsdeltagare
CallResult	Gränssnittet som används som överordnat till [action]CallResult
CallTransferAccepted	Händelse när överföringsbegäran lyckades.
CallTransferFailed	Händelse när överföringsbegäran misslyckades.
CancelAddParticipantFailed	Det gick inte att avbryta lägg till deltagarhändelse.
CancelAddParticipantOperationOptions	Alternativ för att avbryta lägg till deltagarbegäran.
CancelAddParticipantOperationResult	Svarsnyttolasten för att avbryta lägg till deltagarbegäran.
CancelAddParticipantSucceeded	Lyckad avbryt lägg till deltagarhändelse.
ChannelAffinity	Kanaltillhörighet för en deltagare
ChoiceResult
ConnectCallOptions	Alternativ för att ansluta begäran.
ConnectFailed
ContinuousDtmfRecognitionOptions	Alternativ för kontinuerlig Dtmf-igenkänning.
ContinuousDtmfRecognitionStopped	Händelsen skickades när den kontinuerliga Dtmf-igenkänningen stoppades.
ContinuousDtmfRecognitionToneFailed	Händelse som skickades när det inte gick att identifiera kontinuerlig Dtmf-ton.
ContinuousDtmfRecognitionToneReceived	Händelse som skickas när Dtmf-tonen togs emot från måldeltagaren i anropet.
CreateCallFailed
CreateCallOptions	Alternativ för att skapa ett anrop.
DownloadRecordingOptions	Alternativ för att ladda ned inspelning.
DtmfData	Dtmf-strömmande data.
DtmfResult
FileSource	FileSource-modellen.
HoldFailed
HoldOptions	Alternativ för att hålla deltagare.
ListParticipantsResult	Svarsnyttolasten för att få deltagare i samtalet.
MediaStreamingFailed
MediaStreamingOptions	Alternativ för direktuppspelning av media.
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	Alternativ för att stänga av ljudet för deltagare.
MuteParticipantResult	Svarsnyttolasten för att stänga av deltagare från anropet.
OutStreamingData	OutboundStreamingAudioData gränssnitt för utgående nyttolast för ljudströmning.
ParticipantsUpdated	Händelse när det fanns en uppdatering av deltagare.
PlayCanceled	Händelse när Media Play avbröts av avbryt-åtgärden.
PlayCompleted	Händelse när Media Play slutfördes.
PlayFailed	Händelse när Media Play misslyckades.
PlayOptions	Alternativ för att spela upp ljud.
PlaySource	PlaySource-modellen.
PlayStarted	Händelse när Media Play startades.
PlayToAllOptions	Alternativ för att spela UppAlla ljud.
RecognitionChoice	Ett val för igenkänning
RecognizeCanceled	Händelse när Mediaigenkänning avbröts av avbryt-åtgärden.
RecognizeCompleted	Händelse när medieigenkänningen har slutförts.
RecognizeFailed	Händelse när mediaigenkänningen misslyckades.
RecordingStateChanged	Händelse när inspelningstillståndet har ändrats.
RecordingStateResult	Svarsnyttolasten för att starta en samtalsinspelning eller få samtalsinspelningstillstånd.
RecordingStorage	Inspelningslagringen
RejectCallOptions	Alternativ för att avvisa anrop.
RemoveParticipantFailed	Det gick inte att ta bort deltagarhändelsen.
RemoveParticipantResult	Svarsnyttolasten för att ta bort deltagare från samtalet.
RemoveParticipantSucceeded	Deltagaren har tagit bort händelsen.
RemoveParticipantsOption	Alternativ för att ta bort deltagare.
RestAddParticipantFailed	Det gick inte att lägga till deltagarhändelsen.
RestAddParticipantSucceeded	Deltagarna har lagt till händelsen.
RestAnswerFailed	Det gick inte att besvara samtalshändelsen.
RestCallConnected	Den samtalsanslutna händelsen.
RestCallDisconnected	Den frånkopplade händelsen för samtalet.
RestCallTransferAccepted	Anropsöverföringen accepterade händelsen.
RestCallTransferFailed	Anropsöverföringen misslyckades.
RestCancelAddParticipantFailed	Det gick inte att avbryta lägg till deltagarhändelse.
RestCancelAddParticipantSucceeded	Lyckad avbryt lägg till deltagarhändelse.
RestConnectFailed	ConnectFailed-händelsen.
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	Händelsen för att skapa anropet misslyckades.
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	Deltagarna uppdaterades i ett samtalsevenemang.
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	Spela upp startad händelse.
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	Det gick inte att ta bort deltagarhändelsen.
RestRemoveParticipantSucceeded	Deltagaren tog bort händelsen.
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	Händelse som skickas när Dtmf-toner skickas.
SendDtmfTonesFailed	Händelsen skickades när Dtmf-toner kunde skickas misslyckades.
SendDtmfTonesOptions	Alternativ för att skicka Dtmf-toner.
SendDtmfTonesResult	Svarsnyttolasten för att skicka DTMF-toner.
SipCustomHeader	ANPASSAD SIP-rubrik.
SipUserToUserHeader	SIP-huvud för användare till användare.
SpeechResult	Talstatusen som ett resultat.
SsmlSource	SsmlSource-modellen.
StartMediaStreamingOptions	Alternativ för att starta mediaströmningsbegäran.
StartRecordingFailed	Händelse när StartRecording misslyckades.
StartRecordingOptions	Alternativ för att starta en inspelning.
StartTranscriptionOptions	Alternativ för att starta transkription
StopAudio
StopMediaStreamingOptions	Alternativ för att stoppa mediaströmningsbegäran.
StopTranscriptionOptions	Alternativ för att stoppa transkription
TextSource	TextSource-modellen.
TranscriptionData	Transkription av direktuppspelning.
TranscriptionFailed
TranscriptionMetadata	Metadata för transkriptionsströmning.
TranscriptionOptions	Alternativ för direktuppspelning av media.
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	Svarsnyttolasten för överföring av anropet.
TransferCallToParticipantOptions	Alternativ för att överföra deltagare.
UnholdOptions	Alternativ för att ta bort deltagare.
UpdateTranscriptionOptions	Alternativ för att uppdatera transkription
VoipHeader	VOIP-rubrik.
WordData	Text i frasen.

Typalias

AnswerCallResult	AnswerCall-resultat
AudioFormat	Definierar värden för AudioFormat. <xref:KnownAudioFormat> kan användas synonymt med AudioFormat, innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten pcm16KMono pcm24KMono
CallAutomationEvent	Återanropshändelser för Samtalsautomation
CallConnectionStateModel	Definierar värden för CallConnectionStateModel. <xref:KnownCallConnectionStateModel> kan användas omväxlande med CallConnectionStateModel innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten okänd ansluta anslutna överföra överföringAccepterad koppla från frånkopplad
CallLocatorType	Positionerartypen för ett anrop.
CallRejectReason	Definierar värden för CallRejectReason. KnownCallRejectReason- kan användas utbytbart med CallRejectReason innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten ingen upptagen förbjudet
ConnectCallResult	ConnectCall resultat
CreateCallResult	CreateCall-resultat
CustomCallingContext	Anpassad samtalskontext
DeleteRecordingOptions	Alternativ för att ta bort inspelning.
GetCallConnectionPropertiesOptions	Alternativ för att hämta egenskaper för samtalsanslutning.
GetParticipantOptions	Alternativ för att hämta en deltagare.
GetRecordingPropertiesOptions	Alternativ för att hämta inspelningsegenskaper.
HangUpOptions	Alternativ för att lägga på samtalet
MediaKind	Typ av strömmande media.
MediaStreamingAudioChannelType	Definierar värden för MediaStreamingAudioChannelType. KnownMediaStreamingAudioChannelType kan användas synonymt med MediaStreamingAudioChannelType, den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten blandad raffinera
MediaStreamingContentType	Definierar värden för MediaStreamingContentType. KnownMediaStreamingContentType kan användas synonymt med MediaStreamingContentType, den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten ljud
PauseRecordingOptions	Alternativ för att pausa en inspelning.
RecognitionType	Definierar värden för RecognitionType. <xref:KnownRecognitionType> kan användas utbytbart med RecognitionType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Dtmf tal alternativ
RecordingChannel	Kanaltypen för en samtalsinspelning.
RecordingContent	Innehållstypen för en samtalsinspelning.
RecordingFormat	Formattypen för en samtalsinspelning.
RecordingKind	Formattypen för en samtalsinspelning.
RecordingState	Definierar värden för RecordingState. <xref:KnownRecordingState> kan användas omväxlande med RecordingState innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten aktiv inaktiv
RecordingStorageKind	Lagringstypen för en samtalsinspelning.
RedirectCallOptions	Alternativ för att omdirigera anrop.
ResumeRecordingOptions	Alternativ för att återuppta inspelningen.
SipHeaderPrefix	Typen av prefix för Sip-rubriken.
StopRecordingOptions	Alternativ för att stoppa en inspelning.
StreamingDataKind
StreamingDataResult
Tone	Definierar värden för Tone. <xref:KnownTone> kan användas omväxlande med Tone innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten noll en två tre fyra fem sex sju åtta nio en b c d pund asterisk

Uppräkningar

Channel
DtmfTone	En Dtmf-ton.
KnownCallRejectReason	Kända värden för CallRejectReason som tjänsten accepterar.
KnownMediaStreamingAudioChannelType	Kända värden för MediaStreamingAudioChannelType som tjänsten accepterar.
KnownMediaStreamingContentType	Kända värden för MediaStreamingContentType som tjänsten accepterar.
KnownStreamingTransportType	Kända värden för KnownStreamingTransportType som tjänsten accepterar.
RecognizeInputType	Typen av igenkänning som tjänsten accepterar.
VoiceKind	Definierar värden för VoiceKind som tjänsten accepterar.

Funktioner

createOutboundAudioData(string)	Hjälpfunktion för att skapa utgående ljuddatanyttolast.
createOutboundStopAudioData()	Hjälpfunktion för att skapa utgående stoppljuddatanyttolast.
parseCallAutomationEvent(string | Record<string, unknown>)	Hjälpfunktionen för att parsa acs-motringningshändelser.

Funktionsinformation

createOutboundAudioData(string)

Hjälpfunktion för att skapa utgående ljuddatanyttolast.

function createOutboundAudioData(data: string): string

Parametrar

data

string

Returer

string

createOutboundStopAudioData()

Hjälpfunktion för att skapa utgående stoppljuddatanyttolast.

function createOutboundStopAudioData(): string

Returer

string

parseCallAutomationEvent(string | Record<string, unknown>)

Hjälpfunktionen för att parsa acs-motringningshändelser.

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

Parametrar

encodedEvents

string | Record<string, unknown>

Returer

CallAutomationEvent