@azure/communication-call-automation package

Klassen

CallAutomationClient	Een CallAutomationClient vertegenwoordigt een client naar de Azure Communication CallAutomation-service.
CallConnection	CallConnection-klasse vertegenwoordigt aanroepverbindingen gebaseerde API's.
CallMedia	CallMedia-klasse vertegenwoordigt aanroepmedia-API's.
CallRecording	De klasse CallRecording vertegenwoordigt aanroepopnamegerelateerde API's.
StreamingData	Klasse om het parseren van inkomende streaminggegevens af te handelen.

Interfaces

AddParticipantFailed	De deelnemergebeurtenis kan niet worden toegevoegd.
AddParticipantOptions	Opties om deelnemers toe te voegen.
AddParticipantResult	De nettolading van het antwoord voor het toevoegen van deelnemers aan het gesprek.
AddParticipantSucceeded	De deelnemer heeft de gebeurtenis toegevoegd.
AnswerCallOptions	Opties om een gesprek te beantwoorden.
AnswerFailed
AudioData	Audiostreaminggegevens.
AudioMetadata	Metagegevens voor audiostreaming.
CallAutomationClientOptions	Clientopties die worden gebruikt om CallAutomation Client API-aanvragen te configureren.
CallConnected	Gebeurtenis wanneer de oproep tot stand is gebracht.
CallConnectionProperties	Eigenschappen van een oproepverbinding
CallDisconnected	Gebeurtenis toen alle deelnemers vertrokken en oproep werd beëindigd.
CallIntelligenceOptions	AI-opties voor de aanroep.
CallInvite	Bel de details van de genodigde.
CallLocator	De locator die wordt gebruikt om deel te nemen aan een oproep of actie te ondernemen.
CallMediaRecognizeChoiceOptions	De herkenningsconfiguratie die specifiek is voor Choices.
CallMediaRecognizeDtmfOptions	De herkenningsconfiguratie die specifiek is voor Dtmf.
CallMediaRecognizeOptions	Opties voor het configureren van de recognize-bewerking.
CallMediaRecognizeSpeechOptions	De herkenningsconfiguratie die specifiek is voor Spraak.
CallMediaRecognizeSpeechOrDtmfOptions	De herkenningsconfiguratie voor Spraak of Dtmf
CallParticipant	Contractmodel van een ACS-oproepdeelnemer
CallResult	De interface die wordt gebruikt als bovenliggende interface van [action]CallResult
CallTransferAccepted	Gebeurtenis wanneer de overdrachtsaanvraag is geslaagd.
CallTransferFailed	Gebeurtenis wanneer de overdrachtsaanvraag is mislukt.
CancelAddParticipantFailed	Het is mislukt om het toevoegen van een deelnemergebeurtenis te annuleren.
CancelAddParticipantOperationOptions	Opties voor het annuleren van de aanvraag voor deelnemers toevoegen.
CancelAddParticipantOperationResult	De nettolading van het antwoord voor het annuleren van de aanvraag van een deelnemer.
CancelAddParticipantSucceeded	Het toevoegen van deelnemers is geannuleerd.
ChannelAffinity	Kanaalaffiniteit voor een deelnemer
ChoiceResult
ConnectCallOptions	Opties om verbinding te maken met de aanvraag.
ConnectFailed
ContinuousDtmfRecognitionOptions	Opties voor continue Dtmf-herkenning.
ContinuousDtmfRecognitionStopped	Gebeurtenis verzonden wanneer continue Dtmf-herkenning is gestopt.
ContinuousDtmfRecognitionToneFailed	Gebeurtenis verzonden wanneer continue Dtmf-toon niet kan worden herkend.
ContinuousDtmfRecognitionToneReceived	Gebeurtenis verzonden wanneer Dtmf-toon is ontvangen van de beoogde deelnemer in gesprek.
CreateCallFailed
CreateCallOptions	Opties voor het maken van een aanroep.
DownloadRecordingOptions	Opties voor het downloaden van opname.
DtmfData	Dtmf streaming gegevens.
DtmfResult
FileSource	Het FileSource-model.
HoldFailed
HoldOptions	Opties voor het vasthouden van deelnemers.
ListParticipantsResult	De nettolading van het antwoord voor het ophalen van deelnemers aan het gesprek.
MediaStreamingFailed
MediaStreamingOptions	Opties voor mediastreaming.
MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption	Opties voor het dempen van deelnemers.
MuteParticipantResult	De nettolading van het antwoord voor het dempen van deelnemers uit de oproep.
OutStreamingData	OutboundStreamingAudioData-interface voor uitgaande audiostreaming-payload.
ParticipantsUpdated	Gebeurtenis wanneer er een update is uitgevoerd voor een of meer deelnemers.
PlayCanceled	Gebeurtenis wanneer media afspelen is geannuleerd door de bewerking Annuleren.
PlayCompleted	Gebeurtenis wanneer Media play is voltooid.
PlayFailed	Gebeurtenis wanneer media afspelen is mislukt.
PlayOptions	Opties om audio af te spelen.
PlaySource	Het PlaySource-model.
PlayStarted	Gebeurtenis waarop Media Play is gestart.
PlayToAllOptions	Opties omToAll-audio af te spelen.
RecognitionChoice	Een herkenningskeuze
RecognizeCanceled	Gebeurtenis wanneer Media recognize is geannuleerd door de bewerking Annuleren.
RecognizeCompleted	Gebeurtenis wanneer Media recognize is voltooid.
RecognizeFailed	Gebeurtenis wanneer Media recognize is mislukt.
RecordingStateChanged	Gebeurtenis wanneer de opnamestatus is gewijzigd.
RecordingStateResult	De nettolading van het antwoord voor het starten van een oproepopname of het ophalen van de status van de oproepopname.
RecordingStorage	De opnameopslag
RejectCallOptions	Opties om aanroep te weigeren.
RemoveParticipantFailed	Het verwijderen van de deelnemergebeurtenis is mislukt.
RemoveParticipantResult	De nettolading van het antwoord voor het verwijderen van deelnemers uit de oproep.
RemoveParticipantSucceeded	De deelnemer heeft de gebeurtenis verwijderd.
RemoveParticipantsOption	Opties om deelnemers te verwijderen.
RestAddParticipantFailed	De deelnemersgebeurtenis kan niet worden toegevoegd.
RestAddParticipantSucceeded	De deelnemers hebben een gebeurtenis toegevoegd.
RestAnswerFailed	De oproepgebeurtenis kan niet worden beantwoord.
RestCallConnected	De aanroep verbonden gebeurtenis.
RestCallDisconnected	De niet-verbonden oproepgebeurtenis.
RestCallTransferAccepted	De geaccepteerde gebeurtenis voor oproepoverdracht.
RestCallTransferFailed	De oproepoverdracht is mislukt.
RestCancelAddParticipantFailed	Het toevoegen van deelnemers is mislukt.
RestCancelAddParticipantSucceeded	Het toevoegen van deelnemers is geannuleerd.
RestConnectFailed	De gebeurtenis ConnectFailed.
RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed	De gebeurtenis voor het maken van de aanroep is mislukt.
RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated	De deelnemers zijn bijgewerkt in een oproepevenement.
RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted	Afspelen gestarte gebeurtenis.
RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed	Het verwijderen van de deelnemergebeurtenis is mislukt.
RestRemoveParticipantSucceeded	De deelnemer heeft de gebeurtenis verwijderd.
RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted	Gebeurtenis verzonden wanneer Dtmf-tonen zijn verzonden.
SendDtmfTonesFailed	Gebeurtenis verzonden wanneer verzenden van Dtmf-tonen is mislukt.
SendDtmfTonesOptions	Opties voor het verzenden van Dtmf-tonen.
SendDtmfTonesResult	De nettolading van het antwoord voor het verzenden van DTMF-tonen.
SipCustomHeader	SIP Aangepaste header.
SipUserToUserHeader	SIP Gebruiker Naar Gebruiker header.
SpeechResult	De spraakstatus als gevolg hiervan.
SsmlSource	Het SsmlSource-model.
StartMediaStreamingOptions	Opties voor het starten van mediastreamingaanvraag.
StartRecordingFailed	Gebeurtenis wanneer StartRecording is mislukt.
StartRecordingOptions	Opties om een opname te starten.
StartTranscriptionOptions	Opties om transcriptie te starten
StopAudio
StopMediaStreamingOptions	Opties voor het stoppen van mediastreamingaanvraag.
StopTranscriptionOptions	Opties om transcriptie te stoppen
TextSource	Het TextSource-model.
TranscriptionData	Streamingtranscriptie.
TranscriptionFailed
TranscriptionMetadata	Metagegevens voor transcriptiestreaming.
TranscriptionOptions	Opties voor mediastreaming.
TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult	De nettolading van het antwoord voor het overdragen van de oproep.
TransferCallToParticipantOptions	Opties voor het overdragen van deelnemers.
UnholdOptions	Opties voor het ongedaan maken van deelnemer.
UpdateTranscriptionOptions	Opties voor het bijwerken van transcriptie
VoipHeader	VOIP-header.
WordData	Tekst in de woordgroep.

Type-aliassen

AnswerCallResult	AntwoordCall-resultaat
AudioFormat	Definieert waarden voor AudioFormat. <xref:KnownAudioFormat> kan door elkaar worden gebruikt met AudioFormat, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund pcm16KMono pcm24KMono
CallAutomationEvent	Callback-gebeurtenissen voor Gespreksautomatisering
CallConnectionStateModel	Definieert waarden voor CallConnectionStateModel. <xref:KnownCallConnectionStateModel> kan door elkaar worden gebruikt met CallConnectionStateModel, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund onbekende verbinding maken met verbonden overdragen transferGeaccepteerd de verbinding met verbreken verbroken
CallLocatorType	Het type locator van een oproep.
CallRejectReason	Definieert waarden voor CallRejectReason. KnownCallRejectReason kan door elkaar worden gebruikt met CallRejectReason, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund geen bezet verboden
ConnectCallResult	ConnectCall resultaat
CreateCallResult	Resultaat CreateCall
CustomCallingContext	Aangepaste belcontext
DeleteRecordingOptions	Opties voor het verwijderen van opname.
GetCallConnectionPropertiesOptions	Opties voor het ophalen van gespreksverbindingseigenschappen.
GetParticipantOptions	Opties om een deelnemer te krijgen.
GetRecordingPropertiesOptions	Opties voor het ophalen van opname-eigenschappen.
HangUpOptions	Opties om het gesprek op te hangen
MediaKind	Soort streaming media.
MediaStreamingAudioChannelType	Definieert waarden voor MediaStreamingAudioChannelType. KnownMediaStreamingAudioChannelType kan door elkaar worden gebruikt met MediaStreamingAudioChannelType, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund gemengd onvermengd
MediaStreamingContentType	Definieert waarden voor MediaStreamingContentType. KnownMediaStreamingContentType kan door elkaar worden gebruikt met MediaStreamingContentType, deze enum bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund audio
PauseRecordingOptions	Opties voor het onderbreken van een opname.
RecognitionType	Definieert waarden voor RecognitionType. <xref:KnownRecognitionType> kan door elkaar worden gebruikt met RecognitionType, bevat deze enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund dtmf- spraak keuzes
RecordingChannel	Het kanaaltype van een oproepopname.
RecordingContent	Het inhoudstype van een oproepopname.
RecordingFormat	Het indelingstype van een oproepopname.
RecordingKind	Het indelingstype van een oproepopname.
RecordingState	Definieert waarden voor RecordingState. <xref:KnownRecordingState> kan door elkaar worden gebruikt met RecordingState, bevat deze enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund actieve inactieve
RecordingStorageKind	Het opslagtype van een oproepopname.
RedirectCallOptions	Opties voor het omleiden van oproepen.
ResumeRecordingOptions	Opties om de opname te hervatten.
SipHeaderPrefix	Het type van het voorvoegsel van de Sip-koptekst.
StopRecordingOptions	Opties voor het stoppen van een opname.
StreamingDataKind
StreamingDataResult
Tone	Definieert waarden voor Tone. <xref:KnownTone> kan door elkaar worden gebruikt met Tone, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund nul één twee drie vier vijf zes zeven acht negen een b c d pond sterretje

Enums

Channel
DtmfTone	Een Dtmf Tone.
KnownCallRejectReason	Bekende waarden van CallRejectReason die de service accepteert.
KnownMediaStreamingAudioChannelType	Bekende waarden van MediaStreamingAudioChannelType die door de service worden geaccepteerd.
KnownMediaStreamingContentType	Bekende waarden van MediaStreamingContentType die door de service worden geaccepteerd.
KnownStreamingTransportType	Bekende waarden van KnownStreamingTransportType die de service accepteert.
RecognizeInputType	Het type herkenning dat de service accepteert.
VoiceKind	Definieert waarden voor VoiceKind die door de service worden geaccepteerd.

Functies

createOutboundAudioData(string)	Helper-functie om uitgaande audiogegevens-payload te maken.
createOutboundStopAudioData()	Helper-functie om de payload voor uitgaande stop-audiogegevens te maken.
parseCallAutomationEvent(string | Record<string, unknown>)	Helperfunctie voor het parseren van Acs-callback-gebeurtenissen.

Functiedetails

createOutboundAudioData(string)

Helper-functie om uitgaande audiogegevens-payload te maken.

function createOutboundAudioData(data: string): string

Parameters

data

string

Retouren

string

createOutboundStopAudioData()

Helper-functie om de payload voor uitgaande stop-audiogegevens te maken.

function createOutboundStopAudioData(): string

Retouren

string

parseCallAutomationEvent(string | Record<string, unknown>)

Helperfunctie voor het parseren van Acs-callback-gebeurtenissen.

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

Parameters

encodedEvents

string | Record<string, unknown>

Retouren

CallAutomationEvent