Aufruf: subscribeToTonecall: subscribeToTone

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Abonnieren von DTMF (Dual-Tone Multi-Frequency Signaling).Subscribe to DTMF (dual-tone multi-frequency signaling). Auf diese Weise können Sie benachrichtigt werden, wenn der Benutzer die Tasten auf einem "dialpad" drückt.This allows you to be notified when the user presses keys on a "Dialpad".

Hinweis

Die subscribeToTone -Aktion wird nur für Aufrufe unterstützt, die mit serviceHostedMediaConfiginitiiert werden.The subscribeToTone action is supported only for calls that are initiated with serviceHostedMediaConfig.

BerechtigungenPermissions

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.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Nicht unterstütztNot Supported
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot Supported
AnwendungApplication Calls.AccessMedia.AllCalls.AccessMedia.All

HTTP-AnforderungHTTP request

POST /app/calls/{id}/subscribeToTone
POST /applications/{id}/calls/{id}/subscribeToTone

AnforderungsheaderRequest headers

NameName BeschreibungDescription
AuthorizationAuthorization Bearer {token}. Erforderlich.Bearer {token}. Required.

AnforderungstextRequest body

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.In the request body, provide a JSON object with the following parameters.

ParameterParameter TypType BeschreibungDescription
clientContextclientContext StringString Eindeutige Clientkontext Zeichenfolge.Unique client context string. Kann maximal 256 Zeichen aufweisen.Can have a maximum of 256 characters.

AntwortResponse

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 200 OK zurückgegeben.If successful, this method returns 200 OK response code.

BeispielExample

Das folgende Beispiel illustriert, wie Sie diese API aufrufen können.The following example shows how to call this API.

AnforderungRequest

Das folgende Beispiel zeigt die Antwort.The following example shows the request.

POST https://graph.microsoft.com/beta/app/calls/{id}/subscribeToTone
Content-Type: application/json
Content-Length: 46

{
  "clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54"
}
AntwortResponse

Hinweis: Das hier gezeigte Antwortobjekt wurde möglicherweise zur besseren Lesbarkeit gekürzt. Ein tatsächlicher Aufruf gibt alle Eigenschaften zurück.Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 200 OK

{
  "id": "ea91863c-d0a6-4de0-b73a-4c8d63da5d87",
  "status": "completed",
  "createdDateTime": "2019-07-18T19:52:30Z",
  "lastActionDateTime": "2019-07-18T19:52:31Z",
  "clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54",
}
Benachrichtigung-Ton-BenachrichtigungNotification - Tone notification

Die Benachrichtigung enthält Informationen über den Ton, der in der toneinfo -Ressource gedrückt wurde.The notification contain information of the tone pressed in the toneinfo resource.

POST https://bot.contoso.com/api/calls
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "value": [
    {
      "changeType": "updated",
      "resource": "/app/calls/421f1100-411f-4a29-8514-dbbb9caff45",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "state": "established",
        "toneInfo": {
          "@odata.type": "#microsoft.graph.toneInfo",
          "sequenceId": 1,
          "tone": "tone1"
        }
      }
    }
  ]
}