CallMedia class

CallMedia, klasa reprezentuje interfejsy API związane z nośnikami wywołań.

Konstruktory

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

Metody

cancelAllOperations()

Anuluje wszystkie operacje na nośniku w kolejce.

hold(CommunicationIdentifier, HoldOptions)

Wstrzymaj uczestnika podczas odtwarzania dźwięku.

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

Odtwórz dźwięk do określonego uczestnika.

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

Odtwórz wszystkich uczestników.

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

Wyślij ton dtmf.

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Rozpocznij ciągłe rozpoznawanie dtmf, subskrybując ton.

startMediaStreaming(StartMediaStreamingOptions)

Uruchamia przesyłanie strumieniowe multimediów w wywołaniu.

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

Rozpoznawanie danych wejściowych uczestnika.

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Rozpoznawanie danych wejściowych uczestnika.

startTranscription(StartTranscriptionOptions)

Rozpoczyna transkrypcję w wywołaniu

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Zatrzymaj ciągłe rozpoznawanie dtmf, anulując subskrybowanie tonów.

stopMediaStreaming(StopMediaStreamingOptions)

Zatrzymuje przesyłanie strumieniowe multimediów w wywołaniu.

stopTranscription(StopTranscriptionOptions)

Zatrzymuje transkrypcję w wywołaniu.

unhold(CommunicationIdentifier, UnholdOptions)

Usuń uczestnika z blokady.

updateTranscription(string, UpdateTranscriptionOptions)

Zaktualizuj język transkrypcji.

Szczegóły konstruktora

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

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

Parametry

callConnectionId

string

endpoint

string

options

CallAutomationApiClientOptionalParams

Szczegóły metody

cancelAllOperations()

Anuluje wszystkie operacje na nośniku w kolejce.

function cancelAllOperations(): Promise<void>

Zwraca

Promise<void>

hold(CommunicationIdentifier, HoldOptions)

Wstrzymaj uczestnika podczas odtwarzania dźwięku.

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

Parametry

targetParticipant
CommunicationIdentifier

Cele do gry.

options
HoldOptions

Dodatkowe atrybuty dla uczestnika blokady.

Zwraca

Promise<void>

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

Odtwórz dźwięk do określonego uczestnika.

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

Parametry

playSources

(FileSource | TextSource | SsmlSource)[]

Element PlaySource reprezentujący źródła do odtwarzania. Obecnie obsługiwane jest tylko jedno źródło odtwarzania na żądanie.

playTo

CommunicationIdentifier[]

Cele do gry.

options
PlayOptions

Dodatkowe atrybuty do gry.

Zwraca

Promise<void>

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

Odtwórz wszystkich uczestników.

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

Parametry

playSources

(FileSource | TextSource | SsmlSource)[]

Element PlaySource reprezentujący źródła do odtwarzania. Obecnie obsługiwane jest tylko jedno źródło odtwarzania na żądanie.

options
PlayToAllOptions

Dodatkowe atrybuty do gry.

Zwraca

Promise<void>

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

Wyślij ton dtmf.

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

Parametry

tones

string[] | DtmfTone[]

Lista tonów, które mają być wysyłane do uczestnika docelowego.

targetParticipant
CommunicationIdentifier

Uczestnik docelowy.

options
SendDtmfTonesOptions

Dodatkowe atrybuty wysyłania tonów dtmf.

Zwraca

startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Rozpocznij ciągłe rozpoznawanie dtmf, subskrybując ton.

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

Parametry

targetParticipant
CommunicationIdentifier

Uczestnik docelowy.

options
ContinuousDtmfRecognitionOptions

Dodatkowe atrybuty do ciągłego rozpoznawania dtmf.

Zwraca

Promise<void>

startMediaStreaming(StartMediaStreamingOptions)

Uruchamia przesyłanie strumieniowe multimediów w wywołaniu.

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

Parametry

options
StartMediaStreamingOptions

Dodatkowe atrybuty umożliwiające rozpoczęcie przesyłania strumieniowego multimediów.

Zwraca

Promise<void>

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

Rozpoznawanie danych wejściowych uczestnika.

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

Parametry

targetParticipant
CommunicationIdentifier

Uczestnik docelowy.

Zwraca

Promise<void>

startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

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

Rozpoznawanie danych wejściowych uczestnika.

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

Parametry

targetParticipant
CommunicationIdentifier

Uczestnik docelowy.

maxTonesToCollect

number

Maksymalna liczba tonów DTMF do zebrania.

options
CallMediaRecognizeDtmfOptions

Różne atrybuty rozpoznawania.

Zwraca

Promise<void>

startTranscription(StartTranscriptionOptions)

Rozpoczyna transkrypcję w wywołaniu

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

Parametry

options
StartTranscriptionOptions

Dodatkowe atrybuty dla początkowej transkrypcji.

Zwraca

Promise<void>

stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)

Zatrzymaj ciągłe rozpoznawanie dtmf, anulując subskrybowanie tonów.

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

Parametry

targetParticipant
CommunicationIdentifier

Uczestnik docelowy.

options
ContinuousDtmfRecognitionOptions

Dodatkowe atrybuty do ciągłego rozpoznawania dtmf.

Zwraca

Promise<void>

stopMediaStreaming(StopMediaStreamingOptions)

Zatrzymuje przesyłanie strumieniowe multimediów w wywołaniu.

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

Parametry

options
StopMediaStreamingOptions

Dodatkowe atrybuty umożliwiające zatrzymanie przesyłania strumieniowego multimediów.

Zwraca

Promise<void>

stopTranscription(StopTranscriptionOptions)

Zatrzymuje transkrypcję w wywołaniu.

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

Parametry

options
StopTranscriptionOptions

Dodatkowe atrybuty do transkrypcji zatrzymanej.

Zwraca

Promise<void>

unhold(CommunicationIdentifier, UnholdOptions)

Usuń uczestnika z blokady.

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

Parametry

targetParticipant
CommunicationIdentifier

Cele do gry.

options
UnholdOptions

Dodatkowe atrybuty dla uczestnika wstrzymania.

Zwraca

Promise<void>

updateTranscription(string, UpdateTranscriptionOptions)

Zaktualizuj język transkrypcji.

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

Parametry

locale

string

Definiuje nowe ustawienia regionalne dla transkrypcji.

Zwraca

Promise<void>