通話: 拒否call: reject

重要

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.

Bot が着信呼び出しを拒否できるようにします。Enables the bot to reject an incoming call. 着信呼び出し要求は、会議への招待またはピアツーピア呼び出しになることができます。The incoming call request can be an invite to a meeting or a peer to peer call. 15秒後に着信呼び出し要求がタイムアウトします。The incoming call request times out after 15 seconds. この時間内に応答が送信されない場合、通話は自動的に拒否されます。If no response is sent during this time, the call is automatically rejected.

Bot が Azure portal の有効なコールバック URL で登録されると、着信呼び出しは、にchangeType created設定されたcommsnotificationとして配信されます。Once the bot is registered with a valid callback URL in the Azure portal, the incoming call is delivered as a commsNotification with changeType set to created. Bot は、タイムアウトにAnswerなるRejectまで、または呼び出しに期待されます。The bot is expected to Answer or Reject the call before it times out.

注: この API は、着信呼び出しを拒否するためにのみ使用されます。Note: This API is only used to reject incoming calls. 既存の呼び出しを終了するには、代わりにDelete 呼び出しを使用する必要があります。To terminate existing calls, Delete Call should be used instead.

アクセス許可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 NoneNone

HTTP 要求HTTP request

POST /app/calls/{id}/reject

要求ヘッダー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
したがっreason StringString 拒否理由。The rejection reason. 可能な値NoneBusy 、です。ForbiddenPossible values are None, Busy and Forbidden
callbackUricallbackUri StringString 却下アクションの結果が投稿される特定のコールバック URI を bot が提供できるようにします。Allows bots to provide a specific callback URI where the result of the Reject action will be posted. これにより、Reject アクションをトリガーしたのと同じ特定の bot インスタンスに結果を送信することができます。This allows sending the result to the same specific bot instance that triggered the Reject action. 何も指定されていない場合は、bot のグローバルコールバック URI が使用されます。If none is provided, the bot's global callback URI will be used.

応答Response

成功した場合、このメソッドは 202 Accepted 応答コードを返します。応答本文には何も返されません。If successful, this method returns 202 Accepted response code. It does not return anything in the response body.

Examples

次の例は、この API を呼び出す方法を示しています。The following examples 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/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "busy"
}
応答Response

以下は、応答の例です。Here is an example of the response.

HTTP/1.1 202 Accepted

着信呼び出しを拒否する理由Reject an incoming call with 'None' reason

通知-受信Notification - incoming
POST https://bot.contoso.com/api/call
Authorization: Bearer <TOKEN>
Content-Type: application/json
{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "created",
      "resource": "/app/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/app/calls/57dab8b1-894c-409a-b240-bd8beae78896",
        "state": "incoming",
        "direction": "incoming",
        "source": {
          "identity": {
            "user": {
              "displayName": "John",
              "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8"
            }
          },
          "region": "westus",
          "languageId": "en-US"
        },
        "targets": [
          {
            "identity": {
              "application": {
                "displayName": "Calling Bot",
                "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6"
              }
            },
            "region": "westus",
            "languageId": "en-US"
          }
        ],
        "requestedModalities": [ "audio", "video" ]
      }
    }
  ]
}
要求Request

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

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

{
  "reason": "none"
}
応答Response
HTTP/1.1 202 Accepted
通知-削除済みNotification - deleted
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/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/app/calls/57dab8b1-894c-409a-b240-bd8beae78896"
      }
    }
  ]
}