呼び出し: playPromptcall: playPrompt

重要

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.

呼び出しでプロンプトを再生します。Play a prompt in the call.

操作を処理する方法の詳細については、「 commsOperation 」を参照してください。For more information about how to handle operations, see commsOperation

注意

Playpromptアクションは、 serviceHostedMediaConfigで開始された通話に対してのみサポートされています。The playPrompt 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.
アプリケーションApplication なし。None.

HTTP 要求HTTP request

POST /app/calls/{id}/playPrompt

要求ヘッダー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
促しprompts MediaPrompt コレクションMediaPrompt collection 現時点では、1つのプロンプトと種類mediapromptのみがサポートされています。Currently only a single prompt and of type MediaPrompt is supported.
forloop BooleanBoolean ループ値を指定します。The loop value. True は、無限にループすることを示します。True indicates to loop infinitely. 既定値は false です。The default value is false.
clientContextclientContext StringString 一意のクライアントコンテキスト文字列。Unique client context string. 最大256文字を使用できます。Can have a maximum of 256 characters.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文でplayPromptOperationオブジェクトを返します。If successful, this method returns a 200 OK response code and a playPromptOperation object in the response body.

Example

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

要求Request

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

POST https://graph.microsoft.com/beta/app/calls/57dab8b1-894c-409a-b240-bd8beae78896/playPrompt
Content-Type: application/json
Content-Length: 166

{
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",
  "prompts": [
    {
      "@odata.type": "#microsoft.graph.mediaPrompt",
      "mediaInfo": {
        "@odata.type": "#microsoft.graph.mediaInfo",
        "uri": "https://cdn.contoso.com/beep.wav",
        "resourceId": "1D6DE2D4-CD51-4309-8DAA-70768651088E"
      },
    },
  ],
  "loop": false
}
応答Response

応答の例を次に示します。The following is an example of the 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/app/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5

{
  "@odata.type": "#microsoft.graph.playPromptOperation",
  "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
  "status": "running",
  "createdDateTime": "2018-09-06T15:58:41Z",
  "lastActionDateTime": "2018-09-06T15:58:41Z",
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}

通知-操作が完了しましたNotification - operation completed

注: 無限ループが発生した場合、この通知は送信されません。Note: If infinite looping occurs, this notification is not sent.

POST https://bot.contoso.com/api/calls
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resource": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5",
      "resourceData": {
        "@odata.type": "#microsoft.graph.playPromptOperation",
        "@odata.id": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896/operations/0FE0623FD62842EDB4BD8AC290072CC5",
        "@odata.etag": "W/\"54451\"",
        "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c",
        "status": "completed"
      }
    }
  ]
}