Freigeben über


CallMedia class

CallMedia-Klasse stellt aufrufmedienbezogene APIs dar.

Konstruktoren

CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

Methoden

cancelAllOperations()

Bricht alle in die Warteschlange eingereihten Medienvorgänge ab.

hold(CommunicationIdentifier, HoldOptions)

Halten Sie den Teilnehmer während der Audiowiedergabe gedrückt.

play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)

Wiedergeben von Audio für einen bestimmten Teilnehmer.

playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)

Spielen Sie für alle Teilnehmer.

sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)

Senden Sie Dtmf-Töne.

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Starten Sie die kontinuierliche Dtmf-Erkennung, indem Sie Tontöne abonnieren.

startMediaStreaming(StartMediaStreamingOptions)

Startet das Medienstreaming im Anruf.

startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)

Teilnehmereingaben erkennen.

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Teilnehmereingaben erkennen.

startTranscription(StartTranscriptionOptions)

Startet die Transkription im Anruf.

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Beenden Sie die fortlaufende Dtmf-Erkennung, indem Sie die Töne aufheben.

stopMediaStreaming(StopMediaStreamingOptions)

Beendet das Medienstreaming im Anruf.

stopTranscription(StopTranscriptionOptions)

Beendet die Transkription im Anruf.

unhold(CommunicationIdentifier, UnholdOptions)

Teilnehmer aus dem Halteraum entfernen.

updateTranscription(string, UpdateTranscriptionOptions)

Aktualisieren Sie die Transkriptionssprache.

Details zum Konstruktor

CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

new CallMedia(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)

Parameter

callConnectionId

string

endpoint

string

options

CallAutomationApiClientOptionalParams

Details zur Methode

cancelAllOperations()

Bricht alle in die Warteschlange eingereihten Medienvorgänge ab.

function cancelAllOperations(): Promise<void>

Gibt zurück

Promise<void>

hold(CommunicationIdentifier, HoldOptions)

Halten Sie den Teilnehmer während der Audiowiedergabe gedrückt.

function hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Die Ziele, auf die gespielt werden soll.

options
HoldOptions

Zusätzliche Attribute für halteteilnehmer.

Gibt zurück

Promise<void>

play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)

Wiedergeben von Audio für einen bestimmten Teilnehmer.

function play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>

Parameter

playSources

(FileSource | TextSource | SsmlSource)[]

Eine PlaySource, die die zu spielenden Quellen darstellt. Derzeit wird nur einzelne Wiedergabequelle pro Anforderung unterstützt.

playTo

CommunicationIdentifier[]

Die Ziele, auf die gespielt werden soll.

options
PlayOptions

Zusätzliche Attribute für die Wiedergabe.

Gibt zurück

Promise<void>

playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)

Spielen Sie für alle Teilnehmer.

function playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>

Parameter

playSources

(FileSource | TextSource | SsmlSource)[]

Eine PlaySource, die die zu spielenden Quellen darstellt. Derzeit wird nur einzelne Wiedergabequelle pro Anforderung unterstützt.

options
PlayToAllOptions

Zusätzliche Attribute für die Wiedergabe.

Gibt zurück

Promise<void>

sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)

Senden Sie Dtmf-Töne.

function sendDtmfTones(tones: string[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>

Parameter

tones

string[] | DtmfTone[]

Liste der Töne, die an den Zielteilnehmer gesendet werden sollen.

targetParticipant
CommunicationIdentifier

Zielteilnehmer.

options
SendDtmfTonesOptions

Zusätzliche Attribute für das Senden von Dtmf-Tönen.

Gibt zurück

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Starten Sie die kontinuierliche Dtmf-Erkennung, indem Sie Tontöne abonnieren.

function startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Zielteilnehmer.

options
ContinuousDtmfRecognitionOptions

Zusätzliche Attribute für die kontinuierliche Dtmf-Erkennung.

Gibt zurück

Promise<void>

startMediaStreaming(StartMediaStreamingOptions)

Startet das Medienstreaming im Anruf.

function startMediaStreaming(options?: StartMediaStreamingOptions): Promise<void>

Parameter

options
StartMediaStreamingOptions

Zusätzliche Attribute zum Starten des Medienstreamings.

Gibt zurück

Promise<void>

startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)

Teilnehmereingaben erkennen.

function startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Zielteilnehmer.

Gibt zurück

Promise<void>

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Warnung

Diese API ist nun veraltet.

This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.

Teilnehmereingaben erkennen.

function startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Zielteilnehmer.

maxTonesToCollect

number

Maximale Anzahl der zu erfassenden DTMF-Töne.

options
CallMediaRecognizeDtmfOptions

Unterschiedliche Attribute für die Erkennung.

Gibt zurück

Promise<void>

startTranscription(StartTranscriptionOptions)

Startet die Transkription im Anruf.

function startTranscription(options?: StartTranscriptionOptions): Promise<void>

Parameter

options
StartTranscriptionOptions

Zusätzliche Attribute für die Starttranskription.

Gibt zurück

Promise<void>

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Beenden Sie die fortlaufende Dtmf-Erkennung, indem Sie die Töne aufheben.

function stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Zielteilnehmer.

options
ContinuousDtmfRecognitionOptions

Zusätzliche Attribute für die kontinuierliche Dtmf-Erkennung.

Gibt zurück

Promise<void>

stopMediaStreaming(StopMediaStreamingOptions)

Beendet das Medienstreaming im Anruf.

function stopMediaStreaming(options?: StopMediaStreamingOptions): Promise<void>

Parameter

options
StopMediaStreamingOptions

Zusätzliche Attribute zum Beenden des Medienstreamings.

Gibt zurück

Promise<void>

stopTranscription(StopTranscriptionOptions)

Beendet die Transkription im Anruf.

function stopTranscription(options?: StopTranscriptionOptions): Promise<void>

Parameter

options
StopTranscriptionOptions

Zusätzliche Attribute für die Stopptranskription.

Gibt zurück

Promise<void>

unhold(CommunicationIdentifier, UnholdOptions)

Teilnehmer aus dem Halteraum entfernen.

function unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>

Parameter

targetParticipant
CommunicationIdentifier

Die Ziele, auf die gespielt werden soll.

options
UnholdOptions

Zusätzliche Attribute für nicht enthaltene Teilnehmer.

Gibt zurück

Promise<void>

updateTranscription(string, UpdateTranscriptionOptions)

Aktualisieren Sie die Transkriptionssprache.

function updateTranscription(locale: string, options?: UpdateTranscriptionOptions): Promise<void>

Parameter

locale

string

Definiert ein neues Gebietsschema für die Transkription.

Gibt zurück

Promise<void>