Verwalten der Anrufaufzeichnung auf dem Client
Wichtig
Die in diesem Artikel beschriebenen Funktionen befinden sich derzeit in der öffentlichen Vorschauphase. Diese Vorschauversion wird ohne Vereinbarung zum Servicelevel bereitgestellt und ist nicht für Produktionsworkloads vorgesehen. Manche Features werden möglicherweise nicht unterstützt oder sind nur eingeschränkt verwendbar. Weitere Informationen finden Sie unter Zusätzliche Nutzungsbestimmungen für Microsoft Azure-Vorschauen.
Die Anrufaufzeichnung ermöglicht es Ihren Benutzern, ihre Anrufe, die Sie über Azure Communication Services tätigen, aufzuzeichnen. In diesem Artikel erfahren Sie, wie Sie die Aufzeichnung auf der Clientseite verwalten. Bevor Sie beginnen, müssen Sie die Aufzeichnung auf der Serverseite einrichten.
Voraussetzungen
- Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
- Eine bereitgestellte Communication Services-Ressource. Erstellen Sie eine Communication Services-Ressource.
- Ein Benutzerzugriffstoken zum Aktivieren des Anrufclients. Weitere Informationen finden Sie unter Erstellen und Verwalten von Zugriffstoken.
- Optional: Schnellstart zum Hinzufügen von Sprachanrufen zu Ihrer Anwendung
Das SDK installieren
Verwenden Sie den Befehl npm install, um die Common und Calling SDKs von Azure Communication Services für JavaScript zu installieren:
npm install @azure/communication-common --save
npm install @azure/communication-calling --save
Initialisieren erforderlicher Objekte
Für die meisten Anrufvorgänge ist eine CallClient-Instanz erforderlich. Wenn Sie eine neue CallClient-Instanz erstellen, können Sie diese mit benutzerdefinierten Optionen wie einer Logger-Instanz konfigurieren.
Mit der CallClient-Instanz können Sie eine CallAgent-Instanz erstellen, indem Sie den Agent für die Anruferstellung (createCallAgent) aufrufen. Durch diese Methode wird ein CallAgent-Instanzobjekt asynchron zurückgegeben.
Die Methode createCallAgent verwendet CommunicationTokenCredential als Argument, welches ein Benutzerzugriffstoken akzeptiert.
Sie können die Methode getDeviceManager für die Instanz CallClient verwenden, um auf deviceManager zuzugreifen.
const { CallClient } = require('@azure/communication-calling');
const { AzureCommunicationTokenCredential} = require('@azure/communication-common');
const { AzureLogger, setLogLevel } = require("@azure/logger");
// Set the logger's log level
setLogLevel('verbose');
// Redirect log output to console, file, buffer, REST API, or whatever location you want
AzureLogger.log = (...args) => {
console.log(...args); // Redirect log output to console
};
const userToken = '<USER_TOKEN>';
callClient = new CallClient(options);
const tokenCredential = new AzureCommunicationTokenCredential(userToken);
const callAgent = await callClient.createCallAgent(tokenCredential, {displayName: 'optional Azure Communication Services user name'});
const deviceManager = await callClient.getDeviceManager()
Optimale Verwaltung der Konnektivität zwischen SDK und Microsoft-Infrastruktur
Die Call Agent-Instanz unterstützt Sie bei der Verwaltung von Anrufen (Annehmen oder Starten von Anrufen). Damit Ihr Calling SDK funktioniert, muss eine Verbindung mit der Microsoft-Infrastruktur hergestellt werden, um Benachrichtigungen über eingehende Anrufe zu erhalten und andere Anrufdetails zu koordinieren. Ihre Call Agent-Instanz kann zwei Status haben:
Connected (Verbunden) – Der connectionState-Wert Connected für Call Agent bedeutet, dass das Client-SDK verbunden ist und Benachrichtigungen von der Microsoft-Infrastruktur empfangen kann.
Disconnected (Getrennt) – Der connectionState-Wert Disconnected für Call Agent weist darauf hin, dass das SDK nicht ordnungsgemäß verbunden werden kann. Call Agent muss neu erstellt werden.
invalidToken: Wenn ein Token abgelaufen oder ungültig ist, wird dieCall Agent-Instanz mit diesem Fehler getrennt.connectionIssue: Wenn ein Problem mit der Verbindung zwischen dem Client und der Microsoft-Infrastruktur auftritt, gibtCall Agentnach mehreren Versuchen denconnectionIssue-Fehler zurück.
Sie können überprüfen, ob Ihre lokale Call Agent-Instanz mit der Microsoft-Infrastruktur verbunden ist, indem Sie den aktuellen Wert der connectionState-Eigenschaft prüfen. Während eines aktiven Anrufs können Sie auf das connectionStateChanged-Ereignis lauschen, um zu bestimmen, ob sich der Call Agent-Status von Connected in Disconnected ändert.
const connectionState = callAgentInstance.connectionState;
console.log(connectionState); // it may return either of 'Connected' | 'Disconnected'
const connectionStateCallback = (args) => {
console.log(args); // it will return an object with oldState and newState, each of having a value of either of 'Connected' | 'Disconnected'
// it will also return reason, either of 'invalidToken' | 'connectionIssue'
}
callAgentInstance.on('connectionStateChanged', connectionStateCallback);
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung. Zum Verwenden dieser API nutzen Sie die Betaversion des Azure Communication Services Calling Web SDK.
Cloudaufzeichnung
Die Aufrufaufzeichnung ist ein erweitertes Feature der zentralen Aufruf-API. Sie müssen zunächst Anruffunktionen aus dem Calling SDK importieren:
import { Features} from "@azure/communication-calling";
Anschließend können Sie das API-Objekt für die Aufzeichnungsfeatures aus der Anrufinstanz abrufen:
const callRecordingApi = call.feature(Features.Recording);
Um zu ermitteln, ob der Anruf aufgezeichnet wird, prüfen Sie die Eigenschaft isRecordingActive von callRecordingApi. Er gibt Boolean zurück.
const isRecordingActive = callRecordingApi.isRecordingActive;
Sie können auch Aufzeichnungsänderungen abonnieren:
const isRecordingActiveChangedHandler = () => {
console.log(callRecordingApi.isRecordingActive);
};
callRecordingApi.on('isRecordingActiveChanged', isRecordingActiveChangedHandler);
Sie können eine Liste der Aufzeichnungen mithilfe der Eigenschaft recordings von callRecordingApi abrufen. Zurückgegeben wird RecordingInfo[]. Dieses Element enthält den aktuellen Zustand der Cloudaufzeichnung.
const recordings = callRecordingApi.recordings;
recordings.forEach(r => {
console.log("State: ${r.state}");
Sie können auch recordingsUpdated abonnieren und eine Sammlung aktualisierter Aufzeichnungen abrufen. Dieses Ereignis wird immer dann ausgelöst, wenn eine Aufzeichnungsaktualisierung erfolgt.
const cloudRecordingsUpdatedHandler = (args: { added: SDK.RecordingInfo[], removed: SDK.RecordingInfo[]}) => {
console.log('Recording started by: ');
args.added?.forEach(a => {
console.log('State: ${a.state}');
});
console.log('Recording stopped by: ');
args.removed?.forEach(r => {
console.log('State: ${r.state}');
});
};
callRecordingApi.on('recordingsUpdated', cloudRecordingsUpdatedHandler );
Das SDK installieren
Wählen Sie Ihre Datei build.gradle auf Projektebene aus, und fügen Sie mavenCentral() zur Liste der Repositorys unter buildscript und allprojects hinzu:
buildscript {
repositories {
...
mavenCentral()
...
}
}
allprojects {
repositories {
...
mavenCentral()
...
}
}
Fügen Sie dann in der Datei build.gradle auf Modulebene die folgenden Zeilen zum Abschnitt dependencies hinzu:
dependencies {
...
implementation 'com.azure.android:azure-communication-calling:1.0.0'
...
}
Initialisieren der erforderlichen Objekte
Zum Erstellen einer CallAgent-Instanz müssen Sie die createCallAgent-Methode für eine CallClient-Instanz aufrufen. Dieser Aufruf gibt asynchron ein CallAgent-Instanzobjekt zurück.
Die createCallAgent-Methode verwendet CommunicationUserCredential als Argument, womit ein Zugriffstoken gekapselt wird.
Um auf DeviceManager zuzugreifen, müssen Sie zuerst eine callAgent-Instanz erstellen. Anschließend können Sie die CallClient.getDeviceManager-Methode zum Abrufen von DeviceManager verwenden.
String userToken = '<user token>';
CallClient callClient = new CallClient();
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(userToken);
android.content.Context appContext = this.getApplicationContext(); // From within an activity, for instance
CallAgent callAgent = callClient.createCallAgent(appContext, tokenCredential).get();
DeviceManager deviceManager = callClient.getDeviceManager(appContext).get();
Zum Festlegen eines Anzeigenamens für den Anrufer verwenden Sie diese alternative Methode:
String userToken = '<user token>';
CallClient callClient = new CallClient();
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(userToken);
android.content.Context appContext = this.getApplicationContext(); // From within an activity, for instance
CallAgentOptions callAgentOptions = new CallAgentOptions();
callAgentOptions.setDisplayName("Alice Bob");
DeviceManager deviceManager = callClient.getDeviceManager(appContext).get();
CallAgent callAgent = callClient.createCallAgent(appContext, tokenCredential, callAgentOptions).get();
Aufzeichnen von Anrufen
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung. Zum Verwenden dieser API nutzen Sie die Betaversion des Azure Communication Services Calling Android SDK.
Die Anrufaufzeichnung ist ein erweitertes Feature des zentralen Call-Objekts.
Warnung
Bis zur Version 1.1.0 und Betaversion 1.1.0-beta.1 des Azure Communication Services Calling Android SDK sind isRecordingActive und addOnIsRecordingActiveChangedListener Teil des Call-Objekts. Für die neuen Betaversionen wurden diese APIs als erweitertes Feature von Call verschoben.
Sie müssen zunächst das Objekt der Aufzeichnungsfunktion abrufen:
RecordingCallFeature callRecordingFeature = call.feature(Features.RECORDING);
Um anschließend herauszufinden, ob der Anruf aufgezeichnet wird, prüfen Sie die Eigenschaft isRecordingActive von callRecordingFeature. Er gibt boolean zurück.
boolean isRecordingActive = callRecordingFeature.isRecordingActive();
Sie können auch Aufzeichnungsänderungen abonnieren:
private void handleCallOnIsRecordingChanged(PropertyChangedEvent args) {
boolean isRecordingActive = callRecordingFeature.isRecordingActive();
}
callRecordingFeature.addOnIsRecordingActiveChangedListener(handleCallOnIsRecordingChanged);
Wenn Sie die Aufzeichnung aus Ihrer Anwendung heraus starten möchten, sehen Sie sich zunächst die Übersicht über die Anrufaufzeichnung an. Dort finden Sie die Schritte zum Einrichten der Anrufaufzeichnung.
Sobald Sie die Anrufaufzeichnung auf Ihrem Server eingerichtet haben, müssen Sie von Ihrer Android-Anwendung aus den ServerCallId-Wert des Anrufs abrufen und ihn dann an Ihren Server senden, um den Aufzeichnungsprozess zu starten. Sie ermitteln den Wert ServerCallId mithilfe von getServerCallId() aus der CallInfo-Klasse. Sie ermitteln die CallInfo-Klasse im Klassenobjekt mithilfe von getInfo().
try {
String serverCallId = call.getInfo().getServerCallId().get();
// Send serverCallId to your recording server to start the call recording.
} catch (ExecutionException | InterruptedException e) {
} catch (UnsupportedOperationException unsupportedOperationException) {
}
Wenn Sie mit der Aufzeichnung auf dem Server beginnen, wird das Ereignis handleCallOnIsRecordingChanged ausgelöst, und der Wert von callRecordingFeature.isRecordingActive() lautet true.
Genau wie beim Starten der Anrufaufzeichnung müssen Sie, wenn Sie die Aufzeichnung beenden möchten, ServerCallId abrufen und an Ihren Aufzeichnungsserver senden, sodass dieser die Aufzeichnung beenden kann:
try {
String serverCallId = call.getInfo().getServerCallId().get();
// Send serverCallId to your recording server to stop the call recording.
} catch (ExecutionException | InterruptedException e) {
} catch (UnsupportedOperationException unsupportedOperationException) {
}
Wenn Sie die Aufzeichnung auf dem Server beenden, wird das Ereignis handleCallOnIsRecordingChanged ausgelöst, und der Wert von callRecordingFeature.isRecordingActive() lautet false.
Einrichten des Systems
Erstellen des Xcode-Projekts
Erstellen Sie in Xcode ein neues iOS-Projekt, und wählen Sie die Vorlage Single View App (Einzelansicht-App) aus. In diesem Schnellstart wird das SwiftUI-Framework verwendet. Legen Sie daher Sprache auf Swift und Schnittstelle auf SwiftUI fest.
Im Rahmen dieser Schnellstartanleitung werden keine Tests erstellt. Sie können das Kontrollkästchen Tests einschließen deaktivieren.
Installieren des Pakets und der Abhängigkeiten mithilfe von CocoaPods
Erstellen Sie eine Podfile-Datei für die Anwendung, wie in diesem Beispiel:
platform :ios, '13.0' use_frameworks! target 'AzureCommunicationCallingSample' do pod 'AzureCommunicationCalling', '~> 1.0.0' endFühren Sie
pod installaus.Öffnen Sie
.xcworkspacemithilfe von Xcode.
Anfordern des Zugriffs auf das Mikrofon
Um auf das Mikrofon des Geräts zuzugreifen, müssen Sie die Liste der Informationseigenschaften Ihrer App mithilfe von NSMicrophoneUsageDescription aktualisieren. Legen Sie den zugehörigen Wert auf eine Zeichenfolge fest. Diese wird in das Dialogfeld eingeschlossen, mit dem das System Zugriff vom Benutzer anfordert.
Klicken Sie mit der rechten Maustaste auf den Eintrag info.plist in der Projektstruktur, und wählen Sie dann Öffnen als>Quellcode aus. Fügen Sie im Abschnitt <dict> der obersten Ebene die folgenden Zeilen hinzu, und speichern Sie dann die Datei.
<key>NSMicrophoneUsageDescription</key>
<string>Need microphone access for VOIP calling.</string>
Einrichten des App-Frameworks
Öffnen Sie die Datei ContentView.swift Ihres Projekts. Fügen Sie am Anfang der Datei eine import-Deklaration hinzu, um die AzureCommunicationCalling-Bibliothek zu importieren. Importieren Sie außerdem AVFoundation. Dies ist für Audioberechtigungsanforderungen im Code erforderlich.
import AzureCommunicationCalling
import AVFoundation
Initialisieren von „CallAgent“
Um eine CallAgent-Instanz auf der Grundlage von CallClient zu erstellen, müssen Sie eine Methode vom Typ callClient.createCallAgent verwenden, die asynchron ein Objekt vom Typ CallAgent zurückgibt, nachdem es initialisiert wurde.
Übergeben Sie für die Erstellung eines Anrufclients ein Objekt vom Typ CommunicationTokenCredential:
import AzureCommunication
let tokenString = "token_string"
var userCredential: CommunicationTokenCredential?
do {
let options = CommunicationTokenRefreshOptions(initialToken: token, refreshProactively: true, tokenRefresher: self.fetchTokenSync)
userCredential = try CommunicationTokenCredential(withOptions: options)
} catch {
updates("Couldn't created Credential object", false)
initializationDispatchGroup!.leave()
return
}
// tokenProvider needs to be implemented by Contoso, which fetches a new token
public func fetchTokenSync(then onCompletion: TokenRefreshOnCompletion) {
let newToken = self.tokenProvider!.fetchNewToken()
onCompletion(newToken, nil)
}
Übergeben Sie das von Ihnen erstellte CommunicationTokenCredential-Objekt an CallClient, und legen Sie den Anzeigenamen fest:
self.callClient = CallClient()
let callAgentOptions = CallAgentOptions()
options.displayName = " iOS Azure Communication Services User"
self.callClient!.createCallAgent(userCredential: userCredential!,
options: callAgentOptions) { (callAgent, error) in
if error == nil {
print("Create agent succeeded")
self.callAgent = callAgent
} else {
print("Create agent failed")
}
})
Aufzeichnen von Anrufen
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung. Zum Verwenden dieser API nutzen Sie die Betaversion des Azure Communication Services Calling iOS SDK.
Die Anrufaufzeichnung ist ein erweitertes Feature des zentralen Call-Objekts.
Warnung
Bis zur Version 1.1.0 und Betaversion 1.1.0-beta.1 des Azure Communication Services Calling iOS SDK war isRecordingActive Teil des Call-Objekts und didChangeRecordingState Teil des CallDelegate-Delegaten. Für die neuen Betaversionen wurden diese APIs als erweitertes Feature von Call verschoben.
Sie müssen zunächst das Objekt der Aufzeichnungsfunktion abrufen:
let callRecordingFeature = call.feature(Features.recording)
Um anschließend herauszufinden, ob der Anruf aufgezeichnet wird, prüfen Sie die Eigenschaft isRecordingActive von callRecordingFeature. Er gibt Bool zurück.
let isRecordingActive = callRecordingFeature.isRecordingActive;
Sie können die Aufzeichnung von Änderungen auch abonnieren, indem Sie den RecordingCallFeatureDelegate-Delegaten für Ihre Klasse mit dem Ereignis didChangeRecordingState implementieren:
callRecordingFeature.delegate = self
// didChangeRecordingState is a member of RecordingCallFeatureDelegate
public func recordingCallFeature(_ recordingCallFeature: RecordingCallFeature, didChangeRecordingState args: PropertyChangedEventArgs) {
let isRecordingActive = recordingFeature.isRecordingActive
}
Wenn Sie die Aufzeichnung aus Ihrer Anwendung heraus starten möchten, sehen Sie sich zunächst die Übersicht über die Anrufaufzeichnung an. Dort finden Sie die Schritte zum Einrichten der Anrufaufzeichnung.
Sobald Sie die Anrufaufzeichnung auf Ihrem Server eingerichtet haben, müssen Sie von Ihrer iOS-Anwendung aus den ServerCallId-Wert des Anrufs abrufen und ihn dann an Ihren Server senden, um den Aufzeichnungsprozess zu starten. Sie ermitteln den Wert ServerCallId mithilfe von getServerCallId() aus der CallInfo-Klasse. Sie ermitteln die CallInfo-Klasse im Klassenobjekt mithilfe von getInfo().
// Send serverCallId to your recording server to start the call recording.
let serverCallId = call.info.getServerCallId(){ (serverId, error) in }
Wenn Sie mit der Aufzeichnung auf dem Server beginnen, wird das Ereignis didChangeRecordingState ausgelöst, und der Wert von recordingFeature.isRecordingActive lautet true.
Genau wie beim Starten der Anrufaufzeichnung müssen Sie, wenn Sie die Aufzeichnung beenden möchten, ServerCallId abrufen und an Ihren Aufzeichnungsserver senden, sodass dieser die Aufzeichnung beenden kann:
// Send serverCallId to your recording server to stop the call recording.
let serverCallId = call.info.getServerCallId(){ (serverId, error) in }
Wenn Sie die Aufzeichnung auf dem Server beenden, wird das Ereignis didChangeRecordingState ausgelöst, und der Wert von recordingFeature.isRecordingActive lautet false.
Einrichten des Systems
Erstellen des Visual Studio-Projekts
Erstellen Sie für eine UWP-App in Visual Studio 2022 ein neues Projekt vom Typ Leere App (universelles Windows). Nachdem Sie den Projektnamen eingegeben haben, können Sie ein beliebiges Windows SDK höher als Version 10.0.17763.0 auswählen.
Für eine WinUI 3-App erstellen Sie ein neues Projekt mit der Vorlage Leere App, Gepackt (WinUI 3 in Desktop), um eine WinUI 3-Single-Page-Webanwendung einzurichten. Windows-App SDK-Version 1.3 oder höher ist erforderlich.
Installieren Sie das Paket und die Abhängigkeiten mit dem NuGet-Paket-Manager
Die Calling SDK-APIs und -Bibliotheken sind über ein NuGet-Paket öffentlich verfügbar.
In den folgenden Schritten wird veranschaulicht, wie Sie das NuGet-Paket für das Calling SDK suchen, herunterladen und installieren:
- Öffnen Sie den NuGet-Paket-Manager, indem Sie Tools>NuGet-Paket-Manager>NuGet-Pakete für Lösung verwalten auswählen.
- Wählen Sie Durchsuchen aus, und geben Sie dann
Azure.Communication.Calling.WindowsClientin das Suchfeld ein. - Stellen Sie sicher, dass das Kontrollkästchen Vorabversion einbeziehen aktiviert ist.
- Wählen Sie das
Azure.Communication.Calling.WindowsClient-Paket und dannAzure.Communication.Calling.WindowsClient1.4.0-beta.1 oder eine neuere Version aus. - Aktivieren Sie das Kontrollkästchen, das dem Communication Services-Projekt auf der rechten Registerkarte entspricht.
- Wählen Sie die Schaltfläche Installieren aus.
Aufzeichnen von Anrufen
Die Anrufaufzeichnung ist ein erweitertes Feature des zentralen Call-Objekts. Sie müssen zunächst das Objekt der Aufzeichnungsfunktion abrufen:
RecordingCallFeature recordingFeature = call.Features.Recording;
Um anschließend herauszufinden, ob der Anruf aufgezeichnet wird, prüfen Sie die Eigenschaft IsRecordingActive von recordingFeature. Er gibt boolean zurück.
boolean isRecordingActive = recordingFeature.IsRecordingActive;
Sie können auch Aufzeichnungsänderungen abonnieren:
private async void Call__OnIsRecordingActiveChanged(object sender, PropertyChangedEventArgs args)
boolean isRecordingActive = recordingFeature.IsRecordingActive;
}
recordingFeature.IsRecordingActiveChanged += Call__OnIsRecordingActiveChanged;
Complianceaufzeichnung
Die Complianceaufzeichnung basiert auf der Microsoft Teams-Richtlinie. Sie können sie mithilfe dieses Tutorials aktivieren: Einführung in die richtlinienbasierte Aufzeichnung von Teams für Anrufe & Besprechungen.
Die richtlinienbasierte Aufzeichnung wird automatisch gestartet, wenn ein Benutzer, der über die Richtlinie verfügt, einem Anruf beitritt. Um eine Benachrichtigung von Azure Communication Services zur Aufzeichnung zu erhalten, verwenden Sie den folgenden Code:
const callRecordingApi = call.feature(Features.Recording);
const isComplianceRecordingActive = callRecordingApi.isRecordingActive;
const isComplianceRecordingActiveChangedHandler = () => {
console.log(callRecordingApi.isRecordingActive);
};
callRecordingApi.on('isRecordingActiveChanged', isComplianceRecordingActiveChangedHandler);
Sie können die Complianceaufzeichnung auch mithilfe eines benutzerdefinierten Aufzeichnungs-Bots implementieren. Sehen Sie sich dieses GitHub-Beispiel an.