通話: 拒否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 が着信呼び出しを拒否できるようにします。Enable a bot to reject an incoming call. 着信呼び出し要求は、グループ通話またはピアツーピア呼び出しの参加者からの招待状にすることができます。The incoming call request can be an invite from a participant in a group call or a peer-to-peer call. グループ呼び出しへの招待を受信した場合、通知にはchatinfoおよび会議情報のパラメーターが含まれます。If an invite to a group call is received, the notification will contain the chatInfo and meetingInfo parameters.

Bot は、呼び出しがタイムアウトになる前に、呼び出しを応答または拒否することを期待しています。現在のタイムアウト値は15秒です。The bot is expected to answer or reject the call before the call times out. The current timeout value is 15 seconds.

この API は、既に応答されている既存の呼び出しを終了しません。This API does not end existing calls that have already been answered. 呼び出しを終了するには、[呼び出しの削除] を使用します。Use delete call to end a call.

注: Bot は、VoIP を介してのみ到達できます。Note: The bot can only be reached through VoIP. Bot への PSTN 通話はまだサポートされていません。PSTN calling to bot is not yet supported.

アクセス許可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}/reject
POST /communications/calls/{id}/reject

注: /app パスは廃止されます。Note: The /app path is deprecated. 今後は、/communications パスを使用してください。Going forward, use the /communications path.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-typeContent-type application/json. Required.application/json. 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 を提供し、後で通知を受け取ることができます。This allows bots to provide a specific callback URI for the current call to receive later notifications. このプロパティが設定されていない場合は、bot のグローバルコールバック URI が代わりに使用されます。If this property has not been set, the bot's global callback URI will be used instead. これはでhttpsなければなりません。This must be https.

応答Response

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

Examples

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

例 1: 着信呼び出しを ' Busy ' の理由で拒否するExample 1: Reject an incoming call with 'Busy' reason

要求Request

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

{
  "reason": "busy"
}
応答Response
HTTP/1.1 202 Accepted

例 2: 着信呼び出しを ' None ' の理由で拒否するExample 2: Reject an incoming call with 'None' reason

通知-受信Notification - incoming
POST https://bot.contoso.com/api/call
Content-Type: application/json
{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "created",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/communications/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
POST https://graph.microsoft.com/beta/communications/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
Content-Type: application/json
{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896"
      }
    }
  ]
}