通話: subscribeToTonecall: subscribeToTone

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported.

DTMF (デュアルトーンマルチ周波数信号) をサブスクライブします。Subscribe to DTMF (dual-tone multi-frequency signaling). これにより、ユーザーが "Dialpad" のキーを押したときに通知を受けることができます。This allows you to be notified when the user presses keys on a "Dialpad".

注意

SubscribeToToneアクションは、 serviceHostedMediaConfigで開始された通話に対してのみサポートされています。The subscribeToTone action is supported only for calls that are initiated with serviceHostedMediaConfig.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) サポート対象外Not Supported
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポート対象外Not Supported
ApplicationApplication Calls.AccessMedia.AllCalls.AccessMedia.All

HTTP 要求HTTP request

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

注: この/appパスは推奨されていません。Note: The /app path is deprecated. 転送後に、 /communicationsパスを使用します。Going forward, use the /communications path.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

パラメーターParameter Type 説明Description
clientContextclientContext StringString 一意のクライアントコンテキスト文字列。Unique client context string. 最大256文字を使用できます。Can have a maximum of 256 characters.

応答Response

成功した場合、このメソッドは 200 OK 応答コードを返します。If successful, this method returns 200 OK response code.

Example

次の例は、この API を呼び出す方法を示しています。The following example shows how to call this API.

要求Request

次の例は要求を示しています。The following example shows the request.

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

{
  "clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54"
}
応答Response

注: 読みやすくするために、ここに示す応答オブジェクトは短くされている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。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
Location: https://graph.microsoft.com/beta/communications/calls/421f1100-411f-4a29-8514-dbbb9caff45a/operations/ea91863c-d0a6-4de0-b73a-4c8d63da5d87
Content-Type: application/json
Content-Length: 259

{
  "id": "ea91863c-d0a6-4de0-b73a-4c8d63da5d87",
  "status": "completed",
  "clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54",
}
通知-トーン通知Notification - tone notification

通知には、 toneinfoリソースで押されたトーンの情報が含まれています。The notification contain information of the tone pressed in the toneinfo resource.

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