フィードバック 編集

call: reject

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

ボットが着信呼び出しを拒否することを有効にする。 着信呼び出し要求には、グループ通話の参加者からの招待またはピアツーピア通話を指定できます。 グループ通話への招待を受け取った場合、通知には chatInfo パラメーターと meetingInfo パラメーターが含 まれます。

ボットは、通話がアウトする前に、通話に応答または拒否する必要があります。現在のタイムアウト値は 15 秒です。

この API は、既に応答されている既存の呼び出しを終了しません。 削除 呼び出しを使用 して通話を終了します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) サポート対象外
委任 (個人用 Microsoft アカウント) サポート対象外
アプリケーション None

HTTP 要求

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

注: /app パスは廃止されます。 今後は、/communications パスを使用してください。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
Content-type application/json. Required.

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 型 説明
理由 String 拒否理由。 指定できる値は、Busy次Noneのとおりです。Forbidden
callbackUri String これにより、ボットは現在の呼び出しが後で通知を受け取る特定のコールバック URI を提供できます。 このプロパティが設定されていない場合、代わりにボットのグローバル コールバック URI が使用されます。 これは、 である必要があります https。

応答

成功した場合、このメソッドは 202 Accepted 応答コードを返します。応答本文には何も返されません。

例

次の例は、この API を呼び出す方法を示しています。

例 1: 'Busy' 理由を持つ着信呼び出しを拒否する

要求

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

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

例 2: "なし" の理由で着信呼び出しを拒否する

通知 - 受信
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" ]
      }
    }
  ]
}
要求
POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "none"
}
応答
HTTP/1.1 202 Accepted
通知 - 削除済み
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"
      }
    }
  ]
}