call: recordResponse

Artikel
07/18/2022
8 Minuten Lesedauer

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Notieren Sie eine kurze Audioantwort des Anrufers.

Ein Bot kann dies verwenden, um eine Sprachantwort eines Anrufers zu erfassen, nachdem er zur Antwort aufgefordert wurde.

Weitere Informationen zum Behandeln von Vorgängen finden Sie unter commsOperation.

Hinweis: Diese API wird nur für Aufrufe unterstützt, die mit serviceHostedMediaConfig initiiert werden.

Diese Aktion dient nicht zum Aufzeichnen des gesamten Aufrufs. Die maximale Länge der Aufzeichnung beträgt 2 Minuten. Die Aufzeichnung wird von der Cloud Communications-Plattform nicht dauerhaft gespeichert und kurz nach Ende des Anrufs verworfen. Der Bot muss die Aufzeichnung unmittelbar nach Abschluss des Aufzeichnungsvorgangs mithilfe des recordingLocation-Werts herunterladen, der in der abgeschlossenen Benachrichtigung angegeben ist.

Hinweis: Sie dürfen Medieninhalte aus Anrufen oder Besprechungen, auf die Ihre Anwendung zugreift, oder daten, die von diesen Medieninhalten abgeleitet sind, nicht aufzeichnen oder anderweitig speichern. Stellen Sie sicher, dass Sie die Gesetze und Bestimmungen Ihres Bereichs hinsichtlich Datenschutz und Vertraulichkeit der Kommunikation einhalten. Bitte lesen Sie die Nutzungsbedingungen, und wenden Sie sich für weitere Informationen an Ihren Rechtsbeistand.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Nicht unterstützt
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt
Anwendung	Calls.AccessMedia.All

HTTP-Anforderung

POST /app/calls/{id}/recordResponse
POST /communications/calls/{id}/recordResponse

Hinweis: Der /app-Pfad ist veraltet. Verwenden Sie in Zukunft den /communications-Pfad.

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich.
Content-type	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter	Typ	Beschreibung
Fordert	MediaPrompt-Sammlung	Die zu spielenden Eingabeaufforderungen. Die maximal unterstützte MediaPrompt-Sammlungsgröße beträgt 1.
bargeInAllowed	Boolean	Wenn True ist, wird die recordResponse-Anforderung in andere vorhandene Anforderungen für Datensätze/Playprompt in die Warteschlange/zurzeit verarbeitete Datensätze/Playprompt-Anforderungen eingesperrt. Default = false.
initialSilenceTimeoutInSeconds	Int32	Maximale anfängliche Stille (Stille des Benutzers), die ab dem Zeitpunkt zulässig ist, zu dem der Datensatzantwortvorgang gestartet wird, bevor ein Timeout auftritt und der Vorgang fehlschlägt. Wenn wir eine Eingabeaufforderung wiedergeben, wird dieser Timer gestartet, nachdem die Eingabeaufforderung beendet wurde. Standard = 5 Sekunden, Min = 1 Sekunde, Max = 120 Sekunden
maxSilenceTimeoutInSeconds	Int32	Maximale Stille (Pause), die nach Beginn des Sprechens durch einen Benutzer zulässig ist. Standard = 5 Sekunden, Min = 1 Sekunde, Max = 120 Sekunden.
maxRecordDurationInSeconds	Int32	Maximale Dauer für den recordResponse-Vorgang vor dem Beenden der Aufzeichnung. Standard = 5 Sekunden, Min = 1 Sekunde, Max = 120 Sekunden.
playBeep	Boolescher Wert	Wenn "true", wird ein Signal wiedergegeben, um dem Benutzer anzuzeigen, dass er mit der Aufzeichnung seiner Nachricht beginnen kann. Default = true.
stopTones	Zeichenfolgensammlung	Beenden Sie die zum Beenden der Aufzeichnung angegebenen Töne.
Clientcontext	Zeichenfolge	Eindeutige Clientkontextzeichenfolge. Der maximale Grenzwert beträgt 256 Zeichen.

Hinweis: Die maximale Aufzeichnungszeit wurde von 5 Minuten auf 2 Minuten reduziert.

Antwort

Diese Methode gibt einen 200 OK HTTP-Antwortcode und einen Location-Header mit einem URI an die recordOperation zurück, die für diese Anforderung erstellt wurde.

Beispiel

Das folgende Beispiel illustriert, wie Sie diese API aufrufen können.

Beispiel 1: Zeichnet eine kurze Audioantwort des Anrufers auf

Anforderung

Das folgende Beispiel zeigt die Antwort.

POST https://graph.microsoft.com/beta/communications/calls/{id}/recordResponse
Content-Type: application/json
Content-Length: 394

{
  "bargeInAllowed": true,
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",
  "prompts": [
    {
      "@odata.type": "#microsoft.graph.mediaPrompt",
      "mediaInfo": {
        "uri": "https://cdn.contoso.com/beep.wav",
        "resourceId": "1D6DE2D4-CD51-4309-8DAA-70768651088E"
      }
    }
  ],
  "maxRecordDurationInSeconds": 10,
  "initialSilenceTimeoutInSeconds": 5,
  "maxSilenceTimeoutInSeconds": 2,
  "playBeep": true,
  "stopTones": [ "#", "1", "*" ]
}


const options = {
    authProvider,
};

const client = Client.init(options);

const recordOperation = {
  bargeInAllowed: true,
  clientContext: 'd45324c1-fcb5-430a-902c-f20af696537c',
  prompts: [
    {
      '@odata.type': '#microsoft.graph.mediaPrompt',
      mediaInfo: {
        uri: 'https://cdn.contoso.com/beep.wav',
        resourceId: '1D6DE2D4-CD51-4309-8DAA-70768651088E'
      }
    }
  ],
  maxRecordDurationInSeconds: 10,
  initialSilenceTimeoutInSeconds: 5,
  maxSilenceTimeoutInSeconds: 2,
  playBeep: true,
  stopTones: [ '#', '1', '*' ]
};

await client.api('/communications/calls/{id}/recordResponse')
    .version('beta')
    .post(recordOperation);

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var bargeInAllowed = true;

var clientContext = "d45324c1-fcb5-430a-902c-f20af696537c";

var prompts = new List<Prompt>()
{
    new MediaPrompt
    {
        MediaInfo = new MediaInfo
        {
            Uri = "https://cdn.contoso.com/beep.wav",
            ResourceId = "1D6DE2D4-CD51-4309-8DAA-70768651088E"
        }
    }
};

var maxRecordDurationInSeconds = 10;

var initialSilenceTimeoutInSeconds = 5;

var maxSilenceTimeoutInSeconds = 2;

var playBeep = true;

var stopTones = new List<String>()
{
    "#",
    "1",
    "*"
};

await graphClient.Communications.Calls["{call-id}"]
    .RecordResponse(prompts,bargeInAllowed,initialSilenceTimeoutInSeconds,maxSilenceTimeoutInSeconds,maxRecordDurationInSeconds,playBeep,null,stopTones,clientContext)
    .Request()
    .PostAsync();

Wichtig

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/communications/calls/{id}/recordResponse"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

BOOL bargeInAllowed = YES;
payloadDictionary[@"bargeInAllowed"] = bargeInAllowed;

NSString *clientContext = @"d45324c1-fcb5-430a-902c-f20af696537c";
payloadDictionary[@"clientContext"] = clientContext;

NSMutableArray *promptsList = [[NSMutableArray alloc] init];
MSGraphPrompt *prompts = [[MSGraphPrompt alloc] init];
MSGraphMediaInfo *mediaInfo = [[MSGraphMediaInfo alloc] init];
[mediaInfo setUri:@"https://cdn.contoso.com/beep.wav"];
[mediaInfo setResourceId:@"1D6DE2D4-CD51-4309-8DAA-70768651088E"];
[prompts setMediaInfo:mediaInfo];
[promptsList addObject: prompts];
payloadDictionary[@"prompts"] = promptsList;

int32_t maxRecordDurationInSeconds = 10;
payloadDictionary[@"maxRecordDurationInSeconds"] = maxRecordDurationInSeconds;

int32_t initialSilenceTimeoutInSeconds = 5;
payloadDictionary[@"initialSilenceTimeoutInSeconds"] = initialSilenceTimeoutInSeconds;

int32_t maxSilenceTimeoutInSeconds = 2;
payloadDictionary[@"maxSilenceTimeoutInSeconds"] = maxSilenceTimeoutInSeconds;

BOOL playBeep = YES;
payloadDictionary[@"playBeep"] = playBeep;

NSMutableArray *stopTonesList = [[NSMutableArray alloc] init];
[stopTonesList addObject: @"#"];
[stopTonesList addObject: @"1"];
[stopTonesList addObject: @"*"];
payloadDictionary[@"stopTones"] = stopTonesList;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Wichtig

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Boolean bargeInAllowed = true;

String clientContext = "d45324c1-fcb5-430a-902c-f20af696537c";

LinkedList<Prompt> promptsList = new LinkedList<Prompt>();
MediaPrompt prompts = new MediaPrompt();
MediaInfo mediaInfo = new MediaInfo();
mediaInfo.uri = "https://cdn.contoso.com/beep.wav";
mediaInfo.resourceId = "1D6DE2D4-CD51-4309-8DAA-70768651088E";
prompts.mediaInfo = mediaInfo;

promptsList.add(prompts);

int maxRecordDurationInSeconds = 10;

int initialSilenceTimeoutInSeconds = 5;

int maxSilenceTimeoutInSeconds = 2;

Boolean playBeep = true;

LinkedList<String> stopTonesList = new LinkedList<String>();
stopTonesList.add("#");
stopTonesList.add("1");
stopTonesList.add("*");

graphClient.communications().calls("{id}")
    .recordResponse(CallRecordResponseParameterSet
        .newBuilder()
        .withPrompts(promptsList)
        .withBargeInAllowed(bargeInAllowed)
        .withInitialSilenceTimeoutInSeconds(initialSilenceTimeoutInSeconds)
        .withMaxSilenceTimeoutInSeconds(maxSilenceTimeoutInSeconds)
        .withMaxRecordDurationInSeconds(maxRecordDurationInSeconds)
        .withPlayBeep(playBeep)
        .withStreamWhileRecording(null)
        .withStopTones(stopTonesList)
        .withClientContext(clientContext)
        .build())
    .buildRequest()
    .post();

Wichtig

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
bargeInAllowed := true
requestBody.SetBargeInAllowed(&bargeInAllowed)
clientContext := "d45324c1-fcb5-430a-902c-f20af696537c"
requestBody.SetClientContext(&clientContext)
requestBody.SetPrompts( []Prompt {
    msgraphsdk.NewPrompt(),
    SetAdditionalData(map[string]interface{}{
        "@odata.type": "#microsoft.graph.mediaPrompt",
    }
}
maxRecordDurationInSeconds := int32(10)
requestBody.SetMaxRecordDurationInSeconds(&maxRecordDurationInSeconds)
initialSilenceTimeoutInSeconds := int32(5)
requestBody.SetInitialSilenceTimeoutInSeconds(&initialSilenceTimeoutInSeconds)
maxSilenceTimeoutInSeconds := int32(2)
requestBody.SetMaxSilenceTimeoutInSeconds(&maxSilenceTimeoutInSeconds)
playBeep := true
requestBody.SetPlayBeep(&playBeep)
requestBody.SetStopTones( []String {
    "#",
    "1",
    "*",
}
callId := "call-id"
result, err := graphClient.Communications().CallsById(&callId).RecordResponse(call-id).Post(requestBody)

Wichtig

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
    BargeInAllowed = $true
    ClientContext = "d45324c1-fcb5-430a-902c-f20af696537c"
    Prompts = @(
        @{
            "@odata.type" = "#microsoft.graph.mediaPrompt"
        }
    )
    MaxRecordDurationInSeconds = 10
    InitialSilenceTimeoutInSeconds = 5
    MaxSilenceTimeoutInSeconds = 2
    PlayBeep = $true
    StopTones = @(
        "#"
        "1"
        "*"
    )
}

Invoke-MgRecordCommunicationCallResponse -CallId $callId -BodyParameter $params

Wichtig

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5

{
  "@odata.type": "#microsoft.graph.recordOperation",
  "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
  "status": "running",
  "completionReason": null,
  "resultInfo": null,
  "recordingLocation": null,
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}

Benachrichtigung – Vorgang abgeschlossen

POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5",
      "resourceData": {
        "@odata.type": "#microsoft.graph.recordOperation",
        "@odata.id": "/communications/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5",
        "@odata.etag": "W/\"54451\"",
        "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
        "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",
        "status": "completed",
        "recordingLocation": "https://file.location/17e3b46c-f61d-4f4d-9635-c626ef18e6ad",
        "recordingAccessToken": "<access-token>",
        "completionReason": "stopToneDetected"
      }
    }
  ]
}

Beispiel 2: Abrufen der Aufzeichnungsdatei

Hinweis: Medieninhalte aus Anrufen oder Besprechungen, auf die Ihre Anwendung zugreift, oder Daten, die von diesen Medieninhalten abgeleitet sind, dürfen NICHT erfasst oder anderweitig beibehalten werden. Stellen Sie sicher, dass Sie die Gesetze und Bestimmungen Ihres Bereichs hinsichtlich Datenschutz und Vertraulichkeit der Kommunikation einhalten. Bitte lesen Sie die Nutzungsbedingungen, und wenden Sie sich für weitere Informationen an Ihren Rechtsbeistand.

Anforderung

GET https://file.location/17e3b46c-f61d-4f4d-9635-c626ef18e6ad
Authorization: Bearer <recordingAccessToken>

Antwort

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Date: Thu, 17 Jan 2019 01:46:37 GMT
Content-Type: application/octet-stream

(application/octet-stream of size 160696 bytes)

Hinweis: Medieninhalte aus Anrufen oder Besprechungen, auf die Ihre Anwendung zugreift, oder Daten, die von diesen Medieninhalten abgeleitet sind, dürfen NICHT erfasst oder anderweitig beibehalten werden. Stellen Sie sicher, dass Sie die Gesetze und Bestimmungen Ihres Bereichs hinsichtlich Datenschutz und Vertraulichkeit der Kommunikation einhalten. Bitte lesen Sie die Nutzungsbedingungen, und wenden Sie sich für weitere Informationen an Ihren Rechtsbeistand.

call: recordResponse

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Antwort

Beispiel

Beispiel 1: Zeichnet eine kurze Audioantwort des Anrufers auf

Anforderung

Antwort

Benachrichtigung – Vorgang abgeschlossen

Beispiel 2: Abrufen der Aufzeichnungsdatei

Anforderung

Antwort

Feedback