@azure/communication-call-automation package

Klasy

CallAutomationClient	Obiekt CallAutomationClient reprezentuje klienta w usłudze Azure Communication CallAutomation.
CallConnection	Klasa CallConnection reprezentuje interfejsy API oparte na połączeniu wywołań.
CallMedia	CallMedia, klasa reprezentuje interfejsy API związane z nośnikami wywołań.
CallRecording	CallRecording, klasa reprezentuje interfejsy API powiązane z rejestrowaniem wywołań.
StreamingData	Klasa do obsługi analizowania przychodzących danych przesyłanych strumieniowo.

Interfejsy

AddParticipantFailed	Nie można dodać zdarzenia uczestnika.
AddParticipantOptions	Opcje dodawania uczestników.
AddParticipantResult	Ładunek odpowiedzi do dodawania uczestników do wywołania.
AddParticipantSucceeded	Uczestnik pomyślnie dodał zdarzenie.
AnswerCallOptions	Opcje odpowiedzi na połączenie.
AnswerFailed
AudioData	Dane przesyłania strumieniowego audio.
AudioMetadata	Metadane przesyłania strumieniowego audio.
CallAutomationClientOptions	Opcje klienta używane do konfigurowania żądań interfejsu API klienta CallAutomation.
CallConnected	Zdarzenie podczas nawiązywania połączenia.
CallConnectionProperties	Właściwości połączenia wywołania
CallDisconnected	Zdarzenie po opuszczeniu wszystkich uczestników i zakończeniu połączenia.
CallIntelligenceOptions	Opcje sztucznej inteligencji dla wywołania.
CallInvite	Szczegóły zaproszenia do połączenia.
CallLocator	Lokalizator używany do dołączania lub wykonywania akcji na wywołaniu.
CallMediaRecognizeChoiceOptions	Rozpoznaj konfigurację specyficzną dla opcji Wyboru.
CallMediaRecognizeDtmfOptions	Rozpoznaj konfigurację specyficzną dla dtmf.
CallMediaRecognizeOptions	Opcje konfigurowania operacji rozpoznawania.
CallMediaRecognizeSpeechOptions	Konfiguracja rozpoznawania specyficzna dla mowy.
CallMediaRecognizeSpeechOrDtmfOptions	Konfiguracja rozpoznawania mowy lub dtmf
CallParticipant	Model kontraktu uczestnika wywołania ACS
CallResult	Interfejs używany jako element nadrzędny [action]CallResult
CallTransferAccepted	Zdarzenie, gdy żądanie przeniesienia zakończyło się pomyślnie.
CallTransferFailed	Zdarzenie, gdy żądanie przeniesienia nie powiodło się.
CancelAddParticipantFailed	Nie można anulować zdarzenia dodawania uczestnika.
CancelAddParticipantOperationOptions	Opcje anulowania żądania dodawania uczestnika.
CancelAddParticipantOperationResult	Ładunek odpowiedzi na potrzeby anulowania żądania dodawania uczestnika.
CancelAddParticipantSucceeded	Pomyślne anulowanie dodawania zdarzenia uczestnika.
ChannelAffinity	Koligacja kanału dla uczestnika
ChoiceResult
ConnectCallOptions	Opcje nawiązywania połączenia z żądaniem.
ConnectFailed
ContinuousDtmfRecognitionOptions	Opcje ciągłego rozpoznawania dtmf.
ContinuousDtmfRecognitionStopped	Zdarzenie wysyłane po zatrzymaniu ciągłego rozpoznawania dtmf.
ContinuousDtmfRecognitionToneFailed	Zdarzenie wysyłane, gdy nie można rozpoznać ciągłego tonu dtmf.
ContinuousDtmfRecognitionToneReceived	Zdarzenie wysyłane, gdy ton dtmf odebrany od docelowego uczestnika połączenia.
CreateCallFailed
CreateCallOptions	Opcje tworzenia wywołania.
DownloadRecordingOptions	Opcje pobierania nagrania.
DtmfData	Dane przesyłane strumieniowo Dtmf.
DtmfResult
FileSource	Model FileSource.
HoldFailed
HoldOptions	Opcje przechowywania uczestnika.
ListParticipantsResult	Ładunek odpowiedzi umożliwiający uzyskanie uczestników wywołania.
MediaStreamingFailed
MediaStreamingOptions	Opcje strumieniowego przesyłania multimediów.
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	Opcje wyciszenia uczestnika.
MuteParticipantResult	Ładunek odpowiedzi dla wyciszenia uczestnika z wywołania.
OutStreamingData	Interfejs OutboundStreamingAudioData dla ładunku strumieniowego przesyłania dźwięku wychodzącego.
ParticipantsUpdated	Zdarzenie, gdy nastąpiła aktualizacja uczestników.
PlayCanceled	Zdarzenie, gdy odtwarzanie multimediów zostało anulowane przez operację Anuluj.
PlayCompleted	Zdarzenie po pomyślnym zakończeniu odtwarzania multimediów.
PlayFailed	Zdarzenie, gdy odtwarzanie multimediów nie powiodło się.
PlayOptions	Opcje odtwarzania dźwięku.
PlaySource	Model PlaySource.
PlayStarted	Zdarzenie po pomyślnym uruchomieniu odtwarzania multimediów.
PlayToAllOptions	Opcje odtwarzaniaToAll audio.
RecognitionChoice	Wybór rozpoznawania
RecognizeCanceled	Zdarzenie, gdy rozpoznawanie multimediów zostało anulowane przez operację Anuluj.
RecognizeCompleted	Zdarzenie po pomyślnym zakończeniu rozpoznawania multimediów.
RecognizeFailed	Zdarzenie, gdy rozpoznawanie multimediów nie powiodło się.
RecordingStateChanged	Zdarzenie po zmianie stanu nagrywania.
RecordingStateResult	Ładunek odpowiedzi na potrzeby uruchamiania rejestrowania wywołań lub uzyskiwania stanu rejestrowania wywołań.
RecordingStorage	Magazyn nagrywania
RejectCallOptions	Opcje odrzucania wywołania.
RemoveParticipantFailed	Nie można usunąć zdarzenia uczestnika.
RemoveParticipantResult	Ładunek odpowiedzi umożliwiający usunięcie uczestników z wywołania.
RemoveParticipantSucceeded	Uczestnik pomyślnie usunął zdarzenie.
RemoveParticipantsOption	Opcje usuwania uczestników.
RestAddParticipantFailed	Nie można dodać wydarzenia uczestników.
RestAddParticipantSucceeded	Uczestnicy pomyślnie dodali wydarzenie.
RestAnswerFailed	Zdarzenie połączenia nie powiodło się.
RestCallConnected	Wywołanie połączonego zdarzenia.
RestCallDisconnected	Zdarzenie rozłączone wywołania.
RestCallTransferAccepted	Zdarzenie zaakceptowane przez transfer połączeń.
RestCallTransferFailed	Zdarzenie przeniesienia wywołań nie powiodło się.
RestCancelAddParticipantFailed	Nie można anulować dodawania zdarzenia uczestnika.
RestCancelAddParticipantSucceeded	Pomyślne anulowanie dodawania zdarzenia uczestnika.
RestConnectFailed	Zdarzenie ConnectFailed.
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	Zdarzenie tworzenia nie powiodło się.
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	Uczestnicy zaktualizowali się w zdarzeniu wywołania.
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	Odtwórz zdarzenie rozpoczęte.
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	Nie można usunąć zdarzenia uczestnika.
RestRemoveParticipantSucceeded	Uczestnik usunął wydarzenie.
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	Zdarzenie wysyłane po pomyślnym wysłaniu tonów dtmf.
SendDtmfTonesFailed	Zdarzenie wysyłane, gdy wysyłanie tonów dtmf nie powiodło się.
SendDtmfTonesOptions	Opcje wysyłania tonów dtmf.
SendDtmfTonesResult	Ładunek odpowiedzi do wysyłania tonów DTMF.
SipCustomHeader	Nagłówek niestandardowy SIP.
SipUserToUserHeader	Nagłówek SIP User To User (Użytkownik sip do użytkownika).
SpeechResult	W rezultacie stan mowy.
SsmlSource	Model SsmlSource.
StartMediaStreamingOptions	Opcje uruchamiania żądania przesyłania strumieniowego multimediów.
StartRecordingFailed	Zdarzenie, gdy StartRecording zakończyło się niepowodzeniem.
StartRecordingOptions	Opcje rozpoczęcia nagrywania.
StartTranscriptionOptions	Opcje uruchamiania transkrypcji
StopAudio
StopMediaStreamingOptions	Opcje zatrzymania żądania przesyłania strumieniowego multimediów.
StopTranscriptionOptions	Opcje zatrzymywania transkrypcji
TextSource	Model TextSource.
TranscriptionData	Transkrypcja przesyłania strumieniowego.
TranscriptionFailed
TranscriptionMetadata	Metadane przesyłania strumieniowego transkrypcji.
TranscriptionOptions	Opcje strumieniowego przesyłania multimediów.
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	Ładunek odpowiedzi do przeniesienia wywołania.
TransferCallToParticipantOptions	Opcje przenoszenia uczestników.
UnholdOptions	Opcje wstrzymania uczestnika.
UpdateTranscriptionOptions	Opcje aktualizacji transkrypcji
VoipHeader	Nagłówek VOIP.
WordData	Tekst w frazie.

Aliasy typu

AnswerCallResult	Wynik aplikacji AnswerCall
AudioFormat	Definiuje wartości dla AudioFormat. <xref:KnownAudioFormat> może być używany zamiennie z AudioFormat, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę pcm16KMono pcm24KMono
CallAutomationEvent	Zdarzenia wywołania zwrotnego dla automatyzacji wywołań
CallConnectionStateModel	Definiuje wartości elementu CallConnectionStateModel. <xref:KnownCallConnectionStateModel> można używać zamiennie z callConnectionStateModel, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę nieznanych nawiązywania połączenia połączone transferowanie transferAkceptowany rozłączanie rozłączone
CallLocatorType	Typ lokalizatora wywołania.
CallRejectReason	Definiuje wartości callRejectReason. KnownCallRejectReason można używać zamiennie z funkcją CallRejectReason, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę brak zajęty zabronione
ConnectCallResult	Wynik połączenia ConnectCall
CreateCallResult	Wynik createCall
CustomCallingContext	Niestandardowy kontekst wywołań
DeleteRecordingOptions	Opcje usuwania nagrania.
GetCallConnectionPropertiesOptions	Opcje pobierania właściwości połączenia wywołania.
GetParticipantOptions	Opcje pobierania uczestnika.
GetRecordingPropertiesOptions	Opcje pobierania właściwości rejestrowania.
HangUpOptions	Opcje zawieszania połączenia
MediaKind	Rodzaj multimediów strumieniowych.
MediaStreamingAudioChannelType	Definiuje wartości parametru MediaStreamingAudioChannelType. KnownMediaStreamingAudioChannelType może być używany zamiennie z MediaStreamingAudioChannelType, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę mieszany Niezmieszane
MediaStreamingContentType	Definiuje wartości parametru MediaStreamingContentType. KnownMediaStreamingContentType może być używany zamiennie z MediaStreamingContentType, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę dźwięk
PauseRecordingOptions	Opcje wstrzymania nagrania.
RecognitionType	Definiuje wartości dla wartości RecognitionType. <xref:KnownRecognitionType> można używać zamiennie z wartością RecognitionType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę dtmf mowy wyboru
RecordingChannel	Typ kanału nagrania połączenia.
RecordingContent	Typ zawartości nagrania połączenia.
RecordingFormat	Typ formatu nagrania wywołania.
RecordingKind	Typ formatu nagrania wywołania.
RecordingState	Definiuje wartości elementu RecordingState. <xref:KnownRecordingState> można używać zamiennie z funkcją RecordingState, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę aktywne nieaktywne
RecordingStorageKind	Typ magazynu nagrania połączenia.
RedirectCallOptions	Opcje przekierowywania wywołania.
ResumeRecordingOptions	Opcje wznowienia nagrywania.
SipHeaderPrefix	Typ prefiksu nagłówka Sip.
StopRecordingOptions	Opcje zatrzymania nagrywania.
StreamingDataKind
StreamingDataResult
Tone	Definiuje wartości dla tonu. <xref:KnownTone> można używać zamiennie z tonem, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę zero jeden dwóch trzy cztery pięć sześć siedem ośmiu dziewięć b c d funt gwiazdką

Wyliczenia

Channel
DtmfTone	Ton dtmf.
KnownCallRejectReason	Znane wartości CallRejectReason, które akceptuje usługa.
KnownMediaStreamingAudioChannelType	Znane wartości MediaStreamingAudioChannelType akceptowane przez usługę.
KnownMediaStreamingContentType	Znane wartości MediaStreamingContentType akceptowane przez usługę.
KnownStreamingTransportType	Znane wartości KnownStreamingTransportType akceptowanych przez usługę.
RecognizeInputType	Typ rozpoznawania akceptowanego przez usługę.
VoiceKind	Definiuje wartości dla elementu VoiceKind, które akceptuje usługa.

Funkcje

createOutboundAudioData(string)	Funkcja pomocnika do tworzenia ładunku wychodzących danych audio.
createOutboundStopAudioData()	Funkcja pomocnika do tworzenia ładunku danych audio zatrzymania ruchu wychodzącego.
parseCallAutomationEvent(string | Record<string, unknown>)	Funkcja pomocnika do analizowania zdarzeń wywołania zwrotnego acs.

Szczegóły funkcji

createOutboundAudioData(string)

Funkcja pomocnika do tworzenia ładunku wychodzących danych audio.

function createOutboundAudioData(data: string): string

Parametry

data

string

Zwraca

string

createOutboundStopAudioData()

Funkcja pomocnika do tworzenia ładunku danych audio zatrzymania ruchu wychodzącego.

function createOutboundStopAudioData(): string

Zwraca

string

parseCallAutomationEvent(string | Record<string, unknown>)

Funkcja pomocnika do analizowania zdarzeń wywołania zwrotnego acs.

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

Parametry

encodedEvents

string | Record<string, unknown>

Zwraca

CallAutomationEvent