Namespace: microsoft.graph
Zeichnet eine kurze Audioantwort vom Anrufer auf.
Ein Bot kann dies nutzen, um eine Sprachantwort von einem Anrufer zu erfassen, nachdem er zur Eingabe einer Antwort aufgefordert wurde.
Weitere Informationen zur Behandlung von Vorgängen finden Sie unter commsOperation.
Anmerkung: Dies wird nur für Aufrufe unterstützt, die mit serviceHostedMediaConfig initiiert werden.
Diese Aktion soll nicht den gesamten Aufruf aufzeichnen. Die maximale Aufzeichnungsdauer beträgt 2 Minuten. Die Aufzeichnung wird von der Cloud Communications Platform nicht dauerhaft gespeichert und kurz nach Beendigung des Anrufs verworfen. Der Bot muss die Aufzeichnung unverzüglich herunterladen, nachdem der Aufzeichnungsvorgang abgeschlossen ist, indem er den recordingLocation-Wert verwendet, der in der abgeschlossenen Benachrichtigung angegeben ist.
Anmerkung: Gesammelte Medien werden möglicherweise nicht beibehalten. Stellen Sie sicher, dass Sie die Gesetze und Vorschriften Ihrer Region einhalten, wenn es um die Anrufaufzeichnung geht. Weitere Informationen erhalten Sie von einem Rechtsberater.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Weltweiter Service |
US Government L4 |
US Government L5 (DOD) |
China, betrieben von 21Vianet |
✅ |
✅ |
✅ |
❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp |
Berechtigungen mit den geringsten Berechtigungen |
Berechtigungen mit höheren Berechtigungen |
Delegiert (Geschäfts-, Schul- oder Unikonto) |
Nicht unterstützt |
Nicht unterstützt |
Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
Application |
Calls.AccessMedia.All |
Nicht verfügbar. |
HTTP-Anforderung
POST /communications/calls/{id}/recordResponse
Anforderungstext
Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.
Parameter |
Typ |
Beschreibung |
Fordert |
mediaPrompt-Sammlung |
Die Eingabeaufforderungen, die wiedergegeben werden sollen. Die maximal unterstützte mediaPrompt-Sammlungsgröße beträgt 1. |
bargeInAllowed |
Boolesch |
Bei "true" wird die recordResponse-Anforderung in andere vorhandene, in die Warteschlange eingereihte/zurzeit verarbeitete Datensatz-/Playprompt-Anforderungen eingereiht. Standardwert = false. |
initialSilenceTimeoutInSeconds |
Int32 |
Maximale anfängliche Stille (Benutzerstille), die ab dem Zeitpunkt zulässig ist, zu dem wir den Datensatzantwortvorgang starten, bevor ein Timeout auftritt und der Vorgang fehlschlägt. Wenn wir eine Eingabeaufforderung wiedergeben, wird dieser Timer gestartet, nachdem die Eingabeaufforderung abgeschlossen wurde. Standard = 5 Sekunden, Min = 1 Sekunde, Max = 120 Sekunden |
maxSilenceTimeoutInSeconds |
Int32 |
Maximal zulässige Ruhezeit (Pause), nachdem ein Benutzer mit dem Sprechen begonnen hat. 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 |
Boolesch |
Wenn true, gibt einen Signalton ab, um dem Benutzer mitzuteilen, dass er mit der Aufzeichnung seiner Nachricht beginnen kann. Standard = true. |
stopTones |
String collection |
Zum Beenden der Aufzeichnung angegebene Stopptöne. |
clientContext |
Zeichenfolge |
Eindeutige Clientkontextzeichenfolge. Der maximale Grenzwert beträgt 256 Zeichen. |
Antwort
Diese Methode gibt einen 200 OK
Antwortcode und einen Location-Header mit einem URI für die für diese Anforderung erstellte recordOperation zurück.
Beispiel
Das folgende Beispiel illustriert, wie Sie diese API aufrufen können.
Beispiel 1: Zeichnet eine kurze Audioantwort vom Anrufer auf
Anforderung
Das folgende Beispiel zeigt die Antwort.
POST https://graph.microsoft.com/v1.0/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", "*" ]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Communications.Calls.Item.RecordResponse;
using Microsoft.Graph.Models;
var requestBody = new RecordResponsePostRequestBody
{
BargeInAllowed = true,
ClientContext = "d45324c1-fcb5-430a-902c-f20af696537c",
Prompts = new List<Prompt>
{
new MediaPrompt
{
OdataType = "#microsoft.graph.mediaPrompt",
MediaInfo = new MediaInfo
{
Uri = "https://cdn.contoso.com/beep.wav",
ResourceId = "1D6DE2D4-CD51-4309-8DAA-70768651088E",
},
},
},
MaxRecordDurationInSeconds = 10,
InitialSilenceTimeoutInSeconds = 5,
MaxSilenceTimeoutInSeconds = 2,
PlayBeep = true,
StopTones = new List<string>
{
"#",
"1",
"*",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Communications.Calls["{call-id}"].RecordResponse.PostAsync(requestBody);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
mgc communications calls record-response post --call-id {call-id} --body '{\
"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", "*" ]\
}\
'
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphcommunications "github.com/microsoftgraph/msgraph-sdk-go/communications"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphcommunications.NewRecordResponsePostRequestBody()
bargeInAllowed := true
requestBody.SetBargeInAllowed(&bargeInAllowed)
clientContext := "d45324c1-fcb5-430a-902c-f20af696537c"
requestBody.SetClientContext(&clientContext)
prompt := graphmodels.NewMediaPrompt()
mediaInfo := graphmodels.NewMediaInfo()
uri := "https://cdn.contoso.com/beep.wav"
mediaInfo.SetUri(&uri)
resourceId := "1D6DE2D4-CD51-4309-8DAA-70768651088E"
mediaInfo.SetResourceId(&resourceId)
prompt.SetMediaInfo(mediaInfo)
prompts := []graphmodels.Promptable {
prompt,
}
requestBody.SetPrompts(prompts)
maxRecordDurationInSeconds := int32(10)
requestBody.SetMaxRecordDurationInSeconds(&maxRecordDurationInSeconds)
initialSilenceTimeoutInSeconds := int32(5)
requestBody.SetInitialSilenceTimeoutInSeconds(&initialSilenceTimeoutInSeconds)
maxSilenceTimeoutInSeconds := int32(2)
requestBody.SetMaxSilenceTimeoutInSeconds(&maxSilenceTimeoutInSeconds)
playBeep := true
requestBody.SetPlayBeep(&playBeep)
stopTones := []string {
"#",
"1",
"*",
}
requestBody.SetStopTones(stopTones)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
recordResponse, err := graphClient.Communications().Calls().ByCallId("call-id").RecordResponse().Post(context.Background(), requestBody, nil)
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.communications.calls.item.recordresponse.RecordResponsePostRequestBody recordResponsePostRequestBody = new com.microsoft.graph.communications.calls.item.recordresponse.RecordResponsePostRequestBody();
recordResponsePostRequestBody.setBargeInAllowed(true);
recordResponsePostRequestBody.setClientContext("d45324c1-fcb5-430a-902c-f20af696537c");
LinkedList<Prompt> prompts = new LinkedList<Prompt>();
MediaPrompt prompt = new MediaPrompt();
prompt.setOdataType("#microsoft.graph.mediaPrompt");
MediaInfo mediaInfo = new MediaInfo();
mediaInfo.setUri("https://cdn.contoso.com/beep.wav");
mediaInfo.setResourceId("1D6DE2D4-CD51-4309-8DAA-70768651088E");
prompt.setMediaInfo(mediaInfo);
prompts.add(prompt);
recordResponsePostRequestBody.setPrompts(prompts);
recordResponsePostRequestBody.setMaxRecordDurationInSeconds(10);
recordResponsePostRequestBody.setInitialSilenceTimeoutInSeconds(5);
recordResponsePostRequestBody.setMaxSilenceTimeoutInSeconds(2);
recordResponsePostRequestBody.setPlayBeep(true);
LinkedList<String> stopTones = new LinkedList<String>();
stopTones.add("#");
stopTones.add("1");
stopTones.add("*");
recordResponsePostRequestBody.setStopTones(stopTones);
var result = graphClient.communications().calls().byCallId("{call-id}").recordResponse().post(recordResponsePostRequestBody);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
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')
.post(recordOperation);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Communications\Calls\Item\RecordResponse\RecordResponsePostRequestBody;
use Microsoft\Graph\Generated\Models\Prompt;
use Microsoft\Graph\Generated\Models\MediaPrompt;
use Microsoft\Graph\Generated\Models\MediaInfo;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RecordResponsePostRequestBody();
$requestBody->setBargeInAllowed(true);
$requestBody->setClientContext('d45324c1-fcb5-430a-902c-f20af696537c');
$promptsPrompt1 = new MediaPrompt();
$promptsPrompt1->setOdataType('#microsoft.graph.mediaPrompt');
$promptsPrompt1MediaInfo = new MediaInfo();
$promptsPrompt1MediaInfo->setUri('https://cdn.contoso.com/beep.wav');
$promptsPrompt1MediaInfo->setResourceId('1D6DE2D4-CD51-4309-8DAA-70768651088E');
$promptsPrompt1->setMediaInfo($promptsPrompt1MediaInfo);
$promptsArray []= $promptsPrompt1;
$requestBody->setPrompts($promptsArray);
$requestBody->setMaxRecordDurationInSeconds(10);
$requestBody->setInitialSilenceTimeoutInSeconds(5);
$requestBody->setMaxSilenceTimeoutInSeconds(2);
$requestBody->setPlayBeep(true);
$requestBody->setStopTones(['#', '1', '*', ]);
$result = $graphServiceClient->communications()->calls()->byCallId('call-id')->recordResponse()->post($requestBody)->wait();
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, 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"
mediaInfo = @{
uri = "https://cdn.contoso.com/beep.wav"
resourceId = "1D6DE2D4-CD51-4309-8DAA-70768651088E"
}
}
)
maxRecordDurationInSeconds = 10
initialSilenceTimeoutInSeconds = 5
maxSilenceTimeoutInSeconds = 2
playBeep = $true
stopTones = @(
"#"
"1"
"*"
)
}
Invoke-MgRecordCommunicationCallResponse -CallId $callId -BodyParameter $params
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.communications.calls.item.record_response.record_response_post_request_body import RecordResponsePostRequestBody
from msgraph.generated.models.prompt import Prompt
from msgraph.generated.models.media_prompt import MediaPrompt
from msgraph.generated.models.media_info import MediaInfo
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RecordResponsePostRequestBody(
barge_in_allowed = True,
client_context = "d45324c1-fcb5-430a-902c-f20af696537c",
prompts = [
MediaPrompt(
odata_type = "#microsoft.graph.mediaPrompt",
media_info = MediaInfo(
uri = "https://cdn.contoso.com/beep.wav",
resource_id = "1D6DE2D4-CD51-4309-8DAA-70768651088E",
),
),
],
max_record_duration_in_seconds = 10,
initial_silence_timeout_in_seconds = 5,
max_silence_timeout_in_seconds = 2,
play_beep = True,
stop_tones = [
"#",
"1",
"*",
],
)
result = await graph_client.communications.calls.by_call_id('call-id').record_response.post(request_body)
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, 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
Content-Type: application/json
Location: https://graph.microsoft.com/v1.0/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",
"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",
"resultInfo": {
"@odata.type": "#microsoft.graph.resultInfo",
"code": 200,
"subcode": 8515,
"message": "Action completed, max record duration reached."
},
"recordingLocation": "https://file.location/17e3b46c-f61d-4f4d-9635-c626ef18e6ad",
"recordingAccessToken": "<access-token>"
}
}
]
}
Beispiel 2: Abrufen der Aufzeichnungsdatei
Anmerkung: Sie dürfen medienbezogene Inhalte von Anrufen oder Besprechungen, auf die Ihre Anwendung zugreift, oder von diesen Medieninhalten abgeleitete Daten NICHT aufzeichnen oder anderweitig beibehalten. Stellen Sie sicher, dass Sie die Gesetze und Vorschriften Ihres Bereichs bezüglich 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)