Partager via


@azure/communication-call-automation package

Classes

CallAutomationClient

Un CallAutomationClient représente un client au service Azure Communication CallAutomation.

CallConnection

La classe CallConnection représente les API basées sur une connexion d’appel.

CallMedia

La classe CallMedia représente les API liées aux médias d’appel.

CallRecording

La classe CallRecording représente les API associées à l’enregistrement des appels.

StreamingData

Classe permettant de gérer l’analyse des données de streaming entrantes.

Interfaces

AddParticipantFailed

Échec de l’ajout de l’événement participant.

AddParticipantOptions

Options d’ajout de participants.

AddParticipantResult

Charge utile de réponse pour l’ajout de participants à l’appel.

AddParticipantSucceeded

Le participant a ajouté l’événement.

AnswerCallOptions

Options pour répondre à un appel.

AnswerFailed
AudioData

Données de streaming audio.

AudioMetadata

Métadonnées de streaming audio.

CallAutomationClientOptions

Options clientes utilisées pour configurer les demandes d’API cliente CallAutomation.

CallConnected

Événement lors de l’établissement de l’appel.

CallConnectionProperties

Propriétés d’une connexion d’appel

CallDisconnected

Événement lorsque tous les participants ont quitté et que l’appel a été arrêté.

CallIntelligenceOptions

Options IA pour l’appel.

CallInvite

Détails de l’invite d’appel.

CallLocator

Localisateur utilisé pour joindre ou prendre des mesures sur un appel.

CallMediaRecognizeChoiceOptions

Configuration de reconnaissance spécifique aux choix.

CallMediaRecognizeDtmfOptions

Configuration de reconnaissance spécifique à Dtmf.

CallMediaRecognizeOptions

Options de configuration de l’opération de reconnaissance.

CallMediaRecognizeSpeechOptions

Configuration de reconnaissance spécifique à Speech.

CallMediaRecognizeSpeechOrDtmfOptions

Configuration de reconnaissance pour Speech ou Dtmf

CallParticipant

Modèle de contrat d’un participant d’appel ACS

CallResult

L’interface utilisée comme parent de [action]CallResult

CallTransferAccepted

Événement lors de la réussite de la demande de transfert.

CallTransferFailed

Événement lors de l’échec de la demande de transfert.

CancelAddParticipantFailed

Échec de l’annulation de l’événement ajouter un participant.

CancelAddParticipantOperationOptions

Options d’annulation de la demande d’ajout de participant.

CancelAddParticipantOperationResult

Charge utile de réponse pour l’annulation de la demande d’ajout de participant.

CancelAddParticipantSucceeded

Annulation réussie de l’événement ajouter un participant.

ChannelAffinity

Affinité de canal pour un participant

ChoiceResult
ConnectCallOptions

Options de connexion de la demande.

ConnectFailed
ContinuousDtmfRecognitionOptions

Options de reconnaissance Dtmf continue.

ContinuousDtmfRecognitionStopped

Événement envoyé lorsque la reconnaissance Dtmf continue s’est arrêtée.

ContinuousDtmfRecognitionToneFailed

Événement envoyé lorsqu’il n’a pas pu reconnaître le ton Dtmf continu.

ContinuousDtmfRecognitionToneReceived

Événement envoyé lorsque le ton Dtmf a reçu du participant ciblé lors de l’appel.

CreateCallFailed
CreateCallOptions

Options de création d’un appel.

DownloadRecordingOptions

Options de téléchargement de l’enregistrement.

DtmfData

Données de streaming Dtmf.

DtmfResult
FileSource

Modèle FileSource.

HoldFailed
HoldOptions

Options pour contenir le participant.

ListParticipantsResult

Charge utile de réponse pour obtenir les participants de l’appel.

MediaStreamingFailed
MediaStreamingOptions

Options de streaming multimédia.

MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption

Options permettant de désactiver le son du participant.

MuteParticipantResult

Charge utile de réponse pour désactiver le participant à partir de l’appel.

OutStreamingData

Interface OutboundStreamingAudioData pour la charge utile de streaming audio sortant.

ParticipantsUpdated

Événement lorsqu’une mise à jour a été mise à jour des participants.

PlayCanceled

Événement lors de l’annulation de la lecture multimédia par l’opération Annuler.

PlayCompleted

Événement lors de la fin de la lecture multimédia.

PlayFailed

Événement lors de l’échec de la lecture multimédia.

PlayOptions

Options de lecture audio.

PlaySource

Modèle PlaySource.

PlayStarted

Événement lors du démarrage de la lecture multimédia.

PlayToAllOptions

Options pour lire l’audioToAll.

RecognitionChoice

Un choix de reconnaissance

RecognizeCanceled

Événement lors de l’annulation de la reconnaissance multimédia par l’opération Annuler.

RecognizeCompleted

Événement où Media Recognize a été correctement terminé.

RecognizeFailed

Événement lors de l’échec de La reconnaissance multimédia.

RecordingStateChanged

Événement lorsque l’état de l’enregistrement a été modifié.

RecordingStateResult

Charge utile de réponse pour démarrer un enregistrement d’appel ou obtenir l’état d’enregistrement des appels.

RecordingStorage

Stockage d’enregistrement

RejectCallOptions

Options de rejet de l’appel.

RemoveParticipantFailed

Échec de la suppression de l’événement de participant.

RemoveParticipantResult

Charge utile de réponse pour supprimer les participants de l’appel.

RemoveParticipantSucceeded

Le participant a correctement supprimé l’événement.

RemoveParticipantsOption

Options de suppression des participants.

RestAddParticipantFailed

Échec de l’ajout de l’événement participants.

RestAddParticipantSucceeded

Les participants ont ajouté l’événement.

RestAnswerFailed

Échec de réponse à l’événement d’appel.

RestCallConnected

Événement connecté à l’appel.

RestCallDisconnected

Événement déconnecté de l’appel.

RestCallTransferAccepted

Événement accepté de transfert d’appel.

RestCallTransferFailed

L’événement de transfert d’appel a échoué.

RestCancelAddParticipantFailed

Échec de l’annulation de l’ajout d’un événement de participant.

RestCancelAddParticipantSucceeded

Annulation réussie de l’événement ajouter un participant.

RestConnectFailed

Événement ConnectFailed.

RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed

Événement d’échec de l’appel de création.

RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated

Les participants ont été mis à jour dans un événement d’appel.

RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted

Lire l’événement démarré.

RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed

Échec de la suppression de l’événement de participant.

RestRemoveParticipantSucceeded

Le participant a supprimé l’événement.

RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted

Événement envoyé lorsque les tonalités Dtmf envoient correctement.

SendDtmfTonesFailed

Événement envoyé lorsque les tonalités Dtmf envoient l’envoi a échoué.

SendDtmfTonesOptions

Options d’envoi de tonalités Dtmf.

SendDtmfTonesResult

Charge utile de réponse pour l’envoi de tonalités DTMF.

SipCustomHeader

En-tête personnalisé SIP.

SipUserToUserHeader

En-tête Utilisateur à utilisateur SIP.

SpeechResult

État de la parole en conséquence.

SsmlSource

Modèle SsmlSource.

StartMediaStreamingOptions

Options de démarrage de la demande de diffusion en continu multimédia.

StartRecordingOptions

Options permettant d’obtenir un enregistrement de démarrage.

StartTranscriptionOptions

Options de démarrage de la transcription

StopAudio
StopMediaStreamingOptions

Options d’arrêt de la demande de streaming multimédia.

StopTranscriptionOptions

Options permettant d’arrêter la transcription

TextSource

Modèle TextSource.

TranscriptionData

Transcription de streaming.

TranscriptionFailed
TranscriptionMetadata

Métadonnées pour la diffusion en continu de transcription.

TranscriptionOptions

Options de streaming multimédia.

TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult

Charge utile de réponse pour le transfert de l’appel.

TransferCallToParticipantOptions

Options de transfert de participants.

UnholdOptions

Options d’annulation du participant.

UpdateTranscriptionOptions

Options de mise à jour de la transcription

VoipHeader

En-tête VOIP.

WordData

Texte dans l’expression.

Alias de type

AnswerCallResult

Résultat AnswerCall

AudioFormat

Définit les valeurs d’AudioFormat.
<xref:KnownAudioFormat> peut être utilisé de manière interchangeable avec AudioFormat, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

pcm16KMono
pcm24KMono

CallAutomationEvent

Événements de rappel pour Call Automation

CallConnectionStateModel

Définit des valeurs pour CallConnectionStateModel.
<xref:KnownCallConnectionStateModel> pouvez être utilisé de manière interchangeable avec CallConnectionStateModel, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

inconnu
connexion
connectée
le transfert de
transfertAccepté
déconnecter
déconnecté

CallLocatorType

Type de localisateur d’un appel.

CallRejectReason

Définit des valeurs pour CallRejectReason.
KnownCallRejectReason peut être utilisé de manière interchangeable avec CallRejectReason, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

aucun
occupé
interdit

ConnectCallResult

Résultat ConnectCall

CreateCallResult

Résultat CreateCall

CustomCallingContext

Contexte d’appel personnalisé

DeleteRecordingOptions

Options de suppression de l’enregistrement.

GetCallConnectionPropertiesOptions

Options permettant d’obtenir les propriétés de connexion d’appel.

GetParticipantOptions

Options permettant d’obtenir un participant.

GetRecordingPropertiesOptions

Options permettant d’obtenir les propriétés d’enregistrement.

HangUpOptions

Options pour raccrocher l’appel

MediaKind

Type de média en streaming.

MediaStreamingAudioChannelType

Définit des valeurs pour MediaStreamingAudioChannelType.
KnownMediaStreamingAudioChannelType peut être utilisé de manière interchangeable avec MediaStreamingAudioChannelType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

mélangé
pur

MediaStreamingContentType

Définit des valeurs pour MediaStreamingContentType.
KnownMediaStreamingContentType peut être utilisé de manière interchangeable avec MediaStreamingContentType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

audio

PauseRecordingOptions

Options permettant d’obtenir une pause d’enregistrement.

RecognitionType

Définit des valeurs pour RecognitionType.
<xref:KnownRecognitionType> pouvez être utilisé de manière interchangeable avec RecognitionType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

dtmf
vocale
choix

RecordingChannel

Type de canal d’un enregistrement d’appel.

RecordingContent

Type de contenu d’un enregistrement d’appel.

RecordingFormat

Type de format d’un enregistrement d’appel.

RecordingKind

Type de format d’un enregistrement d’appel.

RecordingState

Définit des valeurs pour RecordingState.
<xref:KnownRecordingState> pouvez être utilisé de manière interchangeable avec RecordingState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

actif
inactif

RecordingStorageKind

Type de stockage d’un enregistrement d’appel.

RedirectCallOptions

Options pour rediriger l’appel.

ResumeRecordingOptions

Options pour reprendre l’enregistrement.

StopRecordingOptions

Options permettant d’obtenir un enregistrement d’arrêt.

StreamingDataKind
StreamingDataResult
Tone

Définit les valeurs de Tone.
<xref:KnownTone> pouvez être utilisé de manière interchangeable avec Tone, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

zéro
un
deux
trois
quatre
cinq
Six
sept
huit
neuf
un
b
c
d
livre
astérisque

Énumérations

Channel
DtmfTone

Ton Dtmf.

KnownCallRejectReason

Valeurs connues de CallRejectReason que le service accepte.

KnownMediaStreamingAudioChannelType

Valeurs connues de MediaStreamingAudioChannelType acceptées par le service.

KnownMediaStreamingContentType

Valeurs connues de MediaStreamingContentType acceptées par le service.

KnownStreamingTransportType

Valeurs connues de KnownStreamingTransportType que le service accepte.

RecognizeInputType

Type de la reconnaissance que le service accepte.

VoiceKind

Définit les valeurs de VoiceKind que le service accepte.

Functions

createOutboundAudioData(string)

Fonction d’assistance pour créer une charge utile de données audio sortantes.

createOutboundStopAudioData()

Fonction d’assistance pour créer une charge utile de données audio d’arrêt sortant.

parseCallAutomationEvent(string | Record<string, unknown>)

Fonction d’assistance pour l’analyse des événements de rappel Acs.

Informations relatives à la fonction

createOutboundAudioData(string)

Fonction d’assistance pour créer une charge utile de données audio sortantes.

function createOutboundAudioData(data: string): string

Paramètres

data

string

Retours

string

createOutboundStopAudioData()

Fonction d’assistance pour créer une charge utile de données audio d’arrêt sortant.

function createOutboundStopAudioData(): string

Retours

string

parseCallAutomationEvent(string | Record<string, unknown>)

Fonction d’assistance pour l’analyse des événements de rappel Acs.

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

Paramètres

encodedEvents

string | Record<string, unknown>

Retours