call: redirectcall: redirect

重要

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.

着信をリダイレクトします。Redirect an incoming call.

アクセス許可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 Calls.Initiate.AllCalls.Initiate.All

HTTP 要求HTTP request

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

要求ヘッダー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
Targetstargets invitationParticipantInfoコレクションinvitationParticipantInfo collection リダイレクト操作の対象となる参加者。The target participants of the redirect operation.
targetDisposition ポジションtargetDisposition StringString 指定できる値は次のとおりです。defaultThe possible value is: default
timeouttimeout Int32Int32 リダイレクト操作のタイムアウト (秒単位)。The timeout in seconds for the redirect operation.
maskCallee 先maskCallee BooleanBoolean 呼び出し先をマスクするかどうかを示します。Indicates whether to mask the callee.
maskCallermaskCaller BooleanBoolean 発信者をマスクするかどうかを示します。Indicates whether to mask the caller.
callbackUricallbackUri StringString このリダイレクトアクションの結果が投稿される特定のコールバック URI を bot が提供できるようにします。Allows bots to provide a specific callback URI where the result of the Redirect action will be posted. これにより、リダイレクト操作をトリガーしたのと同じ特定の bot インスタンスに結果を送信できるようになります。This allows sending the result to the same specific bot instance that triggered the Redirect action. 何も指定されていない場合は、bot のグローバルコールバック URI が使用されます。If none is provided, the bot's global callback URI will be used.

応答Response

応答202 Acceptedコードを返します。Returns 202 Accepted response code

Examples

通話をリダイレクトするRedirect a call

要求Request

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

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

{
  "targets": [
    {
      "endpointType": "default",
      "identity": {
        "user": {
          "id": "550fae72-d251-43ec-868c-373732c2704f",
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
          "displayName": "Heidi Steen"
        }
      },
      "languageId": "en-US",
      "region": "westus"
    }
  ],
  "targetDisposition": "default",
  "timeout": 99,
  "maskCallee": false,
  "maskCaller": false
}
応答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 202 Accepted

通話を転送するForward a call

通知-受信Notification - incoming
POST https://bot.contoso.com/api/calls
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "value": [
    {
      "changeType": "created",
      "resource": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
        "@odata.etag": "W/\"5445\"",
        "state": "incoming",
        "direction": "incoming",
        "source": {
          "identity": {
            "user": {
              "displayName": "Test User",
              "id": "8A34A46B-3D17-4ADC-8DCE-DC4E7D572698"
            }
          },
          "region": "westus",
          "languageId": "en-US"
        },
        "targets": [
          {
            "identity": {
              "application": {
                "displayName": "Test BOT",
                "id": "8A34A46B-3D17-4ADC-8DCE-DC4E7D572698"
              }
            },
            "region": "westus",
            "languageId": "en-US"
          }
        ],
        "requestedModalities": [ "audio", "video" ]
      }
    }
  ]
}
要求Request
POST https://graph.microsoft.com/beta/app/calls/57DAB8B1894C409AB240BD8BEAE78896/redirect
Authorization: Bearer <TOKEN>
Content-Type: application/json

{
  "targets": [
    {
      "endpointType": "default",
      "identity": {
        "user": {
          "id": "8A34A46B-3D17-4ADC-8DCE-DC4E7D572699"
        }
      },
      "languageId": "en-US",
      "region": "westus"
    }
  ],
  "targetDisposition": "default",
  "timeout": 60,
  "maskCallee": false,
  "maskCaller": false
}
応答Response
HTTP/1.1 202 Accepted
通知-リダイレクトNotification - redirecting
POST https://bot.contoso.com/api/calls
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "value": [
    {
      "changeType": "updated",
      "resource": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
        "@odata.etag": "W/\"5445\"",
        "state": "redirecting"
      }
    }
  ]
}
通知の終了Notification - terminated
POST https://bot.contoso.com/api/calls
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "value": [
    {
      "changeType": "deleted",
      "resource": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/app/calls/57DAB8B1894C409AB240BD8BEAE78896",
        "@odata.etag": "W/\"5445\"",
        "state": "terminated",
        "answeredBy": {
          "identity": {
            "user": {
              "displayName": "Test User 2",
              "id": "8A34A46B-3D17-4ADC-8DCE-DC4E7D572699"
            }
          }
        },
        "terminationReason": "AppRedirected"
      }
    }
  ]
}