@azure/communication-call-automation package

Klassen

CallAutomationClient	Ein CallAutomationClient stellt einen Client für den Azure Communication CallAutomation-Dienst dar.
CallConnection	CallConnection-Klasse stellt verbindungsbasierte APIs dar.
CallMedia	CallMedia-Klasse stellt aufrufmedienbezogene APIs dar.
CallRecording	CallRecording-Klasse stellt verwandte APIs für die Anrufaufzeichnung dar.
StreamingData	Klasse zum Verarbeiten der Analyse eingehender Streamingdaten.

Schnittstellen

AddParticipantFailed	Fehler beim Hinzufügen des Teilnehmerereignisses.
AddParticipantOptions	Optionen zum Hinzufügen von Teilnehmern.
AddParticipantResult	Die Antwortnutzlast zum Hinzufügen von Teilnehmern zum Anruf.
AddParticipantSucceeded	Der Teilnehmer hat das Ereignis erfolgreich hinzugefügt.
AnswerCallOptions	Optionen zum Annehmen eines Anrufs.
AnswerFailed
AudioData	Audiostreamingdaten.
AudioMetadata	Audiostreamingmetadaten.
CallAutomationClientOptions	Clientoptionen zum Konfigurieren von CallAutomation-Client-API-Anforderungen.
CallConnected	Ereignis, als der Aufruf eingerichtet wurde.
CallConnectionProperties	Eigenschaften einer Anrufverbindung
CallDisconnected	Ereignis, wenn alle Teilnehmer verlassen und Anrufen beendet wurden.
CallIntelligenceOptions	KI-Optionen für den Anruf.
CallInvite	Details zum Einladen anrufen.
CallLocator	Der Locator, der für den Beitritt oder die Teilnahme an einer Aktion für einen Anruf verwendet wird.
CallMediaRecognizeChoiceOptions	Die erkennungsspezifische Konfiguration für Auswahlmöglichkeiten.
CallMediaRecognizeDtmfOptions	Die für Dtmf spezifische Erkennungskonfiguration.
CallMediaRecognizeOptions	Optionen zum Konfigurieren des Erkennungsvorgangs.
CallMediaRecognizeSpeechOptions	Die erkennungsspezifische Konfiguration für Sprache.
CallMediaRecognizeSpeechOrDtmfOptions	Die Erkennungskonfiguration für Sprache oder Dtmf
CallParticipant	Vertragsmodell eines ACS-Anrufteilnehmers
CallResult	Die Schnittstelle, die als übergeordnetes Element von [action]CallResult verwendet wird
CallTransferAccepted	Ereignis, wenn die Übertragungsanforderung erfolgreich war.
CallTransferFailed	Ereignis, wenn die Übertragungsanforderung fehlgeschlagen war.
CancelAddParticipantFailed	Fehler beim Abbrechen des Hinzufügens eines Teilnehmerereignisses.
CancelAddParticipantOperationOptions	Optionen zum Abbrechen der Teilnehmeranfrage.
CancelAddParticipantOperationResult	Die Antwortnutzlast zum Abbrechen der Anforderung zum Hinzufügen von Teilnehmern.
CancelAddParticipantSucceeded	Erfolgreiches Abbrechen des Hinzufügens eines Teilnehmerereignisses.
ChannelAffinity	Kanalaffinität für einen Teilnehmer
ChoiceResult
ConnectCallOptions	Optionen zum Herstellen einer Verbindungsanforderung.
ConnectFailed
ContinuousDtmfRecognitionOptions	Optionen für die kontinuierliche Dtmf-Erkennung.
ContinuousDtmfRecognitionStopped	Ereignis, das gesendet wird, wenn die fortlaufende Dtmf-Erkennung beendet wurde.
ContinuousDtmfRecognitionToneFailed	Ereignis, das gesendet wird, wenn der fortlaufende Dtmf-Ton nicht erkannt werden konnte.
ContinuousDtmfRecognitionToneReceived	Ereignis, das gesendet wird, wenn der Dtmf-Ton vom zielbezogenen Teilnehmer im Anruf empfangen wurde.
CreateCallFailed
CreateCallOptions	Optionen zum Erstellen eines Anrufs.
DownloadRecordingOptions	Optionen zum Herunterladen der Aufzeichnung.
DtmfData	DTMF-Streaming-Daten.
DtmfResult
FileSource	Das FileSource-Modell.
HoldFailed
HoldOptions	Optionen zum Halten des Teilnehmers.
ListParticipantsResult	Die Antwortnutzlast zum Abrufen von Teilnehmern des Anrufs.
MediaStreamingFailed
MediaStreamingOptions	Optionen für Medienstreaming.
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	Optionen zum Stummschalten des Teilnehmers.
MuteParticipantResult	Die Antwortnutzlast für das Stummschalten des Teilnehmers vom Anruf.
OutStreamingData	OutboundStreamingAudioData-Schnittstelle für ausgehende Audiostreamingnutzlast.
ParticipantsUpdated	Ereignis, wenn ein Update für Teilnehmer(n) vorhanden war.
PlayCanceled	Ereignis, wenn die Medienwiedergabe durch den Cancel-Vorgang abgebrochen wurde.
PlayCompleted	Ereignis, bei dem die Medienwiedergabe erfolgreich abgeschlossen wurde.
PlayFailed	Ereignis, bei dem die Medienwiedergabe fehlgeschlagen war.
PlayOptions	Optionen zum Wiedergeben von Audio.
PlaySource	Das PlaySource-Modell.
PlayStarted	Ereignis, bei dem die Medienwiedergabe erfolgreich gestartet wurde.
PlayToAllOptions	Optionen zum Wiedergeben vonToAll-Audio.
RecognitionChoice	Erkennungsauswahl
RecognizeCanceled	Ereignis, bei dem die Medienerkennung durch den Cancel-Vorgang abgebrochen wurde.
RecognizeCompleted	Ereignis, bei dem die Medienerkennung erfolgreich abgeschlossen wurde.
RecognizeFailed	Ereignis, bei dem die Medienerkennung fehlgeschlagen war.
RecordingStateChanged	Ereignis, wenn der Aufzeichnungszustand geändert wurde.
RecordingStateResult	Die Antwortnutzlast zum Starten einer Anrufaufzeichnung oder zum Abrufen des Zustands der Anrufaufzeichnung.
RecordingStorage	Der Aufzeichnungsspeicher
RejectCallOptions	Optionen zum Ablehnen des Anrufs.
RemoveParticipantFailed	Fehler beim Entfernen des Teilnehmerereignisses.
RemoveParticipantResult	Die Antwortnutzlast zum Entfernen von Teilnehmern aus dem Anruf.
RemoveParticipantSucceeded	Das Ereignis wurde vom Teilnehmer erfolgreich entfernt.
RemoveParticipantsOption	Optionen zum Entfernen von Teilnehmern.
RestAddParticipantFailed	Fehler beim Hinzufügen des Teilnehmerereignisses.
RestAddParticipantSucceeded	Die Teilnehmer haben erfolgreich ein Ereignis hinzugefügt.
RestAnswerFailed	Fehler beim Annehmen des Anrufereignisses.
RestCallConnected	Das verbundene Anrufereignis.
RestCallDisconnected	Das getrennte Ereignis des Anrufs.
RestCallTransferAccepted	Das akzeptierte Anrufdurchstellungsereignis.
RestCallTransferFailed	Fehler bei der Anrufdurchstellung.
RestCancelAddParticipantFailed	Fehler beim Abbrechen des Hinzufügens eines Teilnehmerereignisses.
RestCancelAddParticipantSucceeded	Erfolgreiches Abbrechen des Hinzufügens eines Teilnehmerereignisses.
RestConnectFailed	Das ConnectFailed-Ereignis.
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	Fehler beim Erstellen eines Aufrufs.
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	Die Teilnehmer wurden in einem Anrufereignis aktualisiert.
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	Ereignis "Spiel gestartet".
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	Fehler beim Entfernen des Teilnehmerereignisses.
RestRemoveParticipantSucceeded	Das Ereignis des Teilnehmers wurde entfernt.
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	Ereignis, das gesendet wird, wenn Dtmf-Töne erfolgreich gesendet werden.
SendDtmfTonesFailed	Ereignis, das gesendet wird, wenn das Senden von Dtmf-Tönen fehlgeschlagen ist.
SendDtmfTonesOptions	Optionen zum Senden von Dtmf-Tönen.
SendDtmfTonesResult	Die Antwortnutzlast zum Senden von DTMF-Tönen.
SipCustomHeader	SIP-Benutzerdefinierter Header.
SipUserToUserHeader	SIP-Benutzer-zu-Benutzer-Kopfzeile.
SpeechResult	Der Sprachstatus als Ergebnis.
SsmlSource	Das SsmlSource-Modell.
StartMediaStreamingOptions	Optionen für die Medienstreaminganforderung starten.
StartRecordingFailed	Ereignis, bei dem StartRecording fehlgeschlagen ist.
StartRecordingOptions	Optionen zum Starten einer Aufzeichnung.
StartTranscriptionOptions	Optionen zum Starten der Transkription
StopAudio
StopMediaStreamingOptions	Optionen zum Beenden der Medienstreaminganforderung.
StopTranscriptionOptions	Optionen zum Beenden der Transkription
TextSource	Das TextSource-Modell.
TranscriptionData	Streamingtranskription.
TranscriptionFailed
TranscriptionMetadata	Metadaten für Transkription Streaming.
TranscriptionOptions	Optionen für Medienstreaming.
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	Die Antwortnutzlast für die Übertragung des Anrufs.
TransferCallToParticipantOptions	Optionen zum Übertragen von Teilnehmern.
UnholdOptions	Optionen zum Aufheben der Zurückbehaltung des Teilnehmers.
UpdateTranscriptionOptions	Optionen zum Aktualisieren der Transkription
VoipHeader	VOIP-Header.
WordData	Text im Ausdruck.

Typaliase

AnswerCallResult	AnswerCall-Ergebnis
AudioFormat	Definiert Werte für AudioFormat. <xref:KnownAudioFormat> kann austauschbar mit AudioFormat verwendet werden, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden pcm16KMono pcm24KMono
CallAutomationEvent	Rückrufereignisse für die Anrufautomatisierung
CallConnectionStateModel	Definiert Werte für CallConnectionStateModel. <xref:KnownCallConnectionStateModel> austauschbar mit CallConnectionStateModel verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden unbekannten verbinden verbundenen übertragung von transferAkzeptiert trennen getrennten
CallLocatorType	Der Locator-Typ eines Anrufs.
CallRejectReason	Definiert Werte für CallRejectReason. KnownCallRejectReason austauschbar mit CallRejectReason verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden keine beschäftigt verbotene
ConnectCallResult	ConnectCall-Ergebnis
CreateCallResult	CreateCall-Ergebnis
CustomCallingContext	Benutzerdefinierter Anrufkontext
DeleteRecordingOptions	Optionen zum Löschen der Aufzeichnung.
GetCallConnectionPropertiesOptions	Optionen zum Abrufen von Verbindungseigenschaften für Aufrufe.
GetParticipantOptions	Optionen zum Abrufen eines Teilnehmers.
GetRecordingPropertiesOptions	Optionen zum Abrufen von Aufzeichnungseigenschaften.
HangUpOptions	Optionen zum Auflegen des Anrufs
MediaKind	Art von Streaming-Medien.
MediaStreamingAudioChannelType	Definiert Werte für MediaStreamingAudioChannelType. KnownMediaStreamingAudioChannelType kann austauschbar mit MediaStreamingAudioChannelType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden gemischt unvermischt
MediaStreamingContentType	Definiert Werte für MediaStreamingContentType. KnownMediaStreamingContentType kann austauschbar mit MediaStreamingContentType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Audio
PauseRecordingOptions	Optionen zum Anhalten einer Aufzeichnung.
RecognitionType	Definiert Werte für RecognitionType. <xref:KnownRecognitionType> austauschbar mit RecognitionType verwendet werden können, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden dtmf- Auswahlmöglichkeiten
RecordingChannel	Der Kanaltyp einer Anrufaufzeichnung.
RecordingContent	Der Inhaltstyp einer Anrufaufzeichnung.
RecordingFormat	Der Formattyp einer Anrufaufzeichnung.
RecordingKind	Der Formattyp einer Anrufaufzeichnung.
RecordingState	Definiert Werte für RecordingState. <xref:KnownRecordingState> austauschbar mit RecordingState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden aktive inaktiven
RecordingStorageKind	Der Speichertyp einer Anrufaufzeichnung.
RedirectCallOptions	Optionen zum Umleiten von Anrufen.
ResumeRecordingOptions	Optionen zum Fortsetzen der Aufzeichnung.
SipHeaderPrefix	Der Typ des Sip-Header-Präfixes.
StopRecordingOptions	Optionen zum Beenden einer Aufzeichnung.
StreamingDataKind
StreamingDataResult
Tone	Definiert Werte für Tone. <xref:KnownTone> austauschbar mit Tone verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden null einer zwei drei vier fünf sechs sieben acht neun einer b c d Pfund Sternchen

Enumerationen

Channel
DtmfTone	Ein Dtmf-Ton.
KnownCallRejectReason	Bekannte Werte von CallRejectReason, die der Dienst akzeptiert.
KnownMediaStreamingAudioChannelType	Bekannte Werte von MediaStreamingAudioChannelType , die der Dienst akzeptiert.
KnownMediaStreamingContentType	Bekannte Werte von MediaStreamingContentType , die der Dienst akzeptiert.
KnownStreamingTransportType	Bekannte Werte von KnownStreamingTransportType, die der Dienst akzeptiert.
RecognizeInputType	Der Typ der Erkennung, die der Dienst akzeptiert.
VoiceKind	Definiert Werte für VoiceKind, die der Dienst akzeptiert.

Functions

createOutboundAudioData(string)	Hilfsfunktion zum Erstellen einer Payload für ausgehende Audiodaten.
createOutboundStopAudioData()	Hilfsfunktion zum Erstellen einer Nutzlast für ausgehende Audio-Stoppdaten.
parseCallAutomationEvent(string | Record<string, unknown>)	Hilfsfunktion zum Analysieren von Acs-Rückrufereignissen.

Details zur Funktion

createOutboundAudioData(string)

Hilfsfunktion zum Erstellen einer Payload für ausgehende Audiodaten.

function createOutboundAudioData(data: string): string

Parameter

data

string

Gibt zurück

string

createOutboundStopAudioData()

Hilfsfunktion zum Erstellen einer Nutzlast für ausgehende Audio-Stoppdaten.

function createOutboundStopAudioData(): string

Gibt zurück

string

parseCallAutomationEvent(string | Record<string, unknown>)

Hilfsfunktion zum Analysieren von Acs-Rückrufereignissen.

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

Parameter

encodedEvents

string | Record<string, unknown>

Gibt zurück

CallAutomationEvent