virtualAppointment の作成 (非推奨)

  • [アーティクル]

名前空間: microsoft.graph

重要

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

注意

virtualAppointment リソースとサポート メソッドは非推奨となり、2023 年 6 月 30 日にデータの返しを停止します。 この API を使用する既存のアプリを更新して、新しい Get join リンク 関数を使用することをお勧めします。

新しい virtualAppointment オブジェクトを 作成します。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) OnlineMeetings.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

注:

仮想予定は、プレビュー期間中にオンライン会議のアクセス許可から、より具体的な仮想予定のアクセス許可に移行します。 これにより、開発者は仮想予定のアクセス許可をより詳細に制御できるようになります。 プレビュー期間が終了する前に、オンライン会議のアクセス許可がサポートされなくなるタイミングに関する詳細を提供します。

HTTP 要求

PUT /me/onlineMeetings/{onlineMeetingId}/virtualAppointment
PUT /users/{userId}/onlineMeetings/{onlineMeetingId}/virtualAppointment

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 virtualAppointment オブジェクトの JSON 表現を指定します。

virtualAppointment を作成するときに、次のプロパティを指定できます。

プロパティ 型 説明
appointmentClients virtualAppointmentUser コレクション 名前、電子メール、SMS 電話番号など、仮想予定のクライアント情報。 省略可能です。
appointmentClientJoinWebUrl String 待機室とブラウザー参加を持つクライアントの仮想予定の結合 Web URL。 省略可能です。
externalAppointmentId String 現在の仮想予定に関連付けられているスケジューリング システムからの予定の識別子。 オプション。
externalAppointmentUrl String 現在の仮想予定に関連付けられているスケジューリング システムからの予定リソースの URL。 省略可能です。
settings virtualAppointmentSettings 仮想予定リソースに関連付けられている設定。 省略可能。

応答

成功した場合、このメソッドは 201 Created 応答コードと応答本文の virtualAppointment オブジェクトを返します。

例

要求

次の例は要求を示しています。

PUT https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi/virtualAppointment
Content-Type: application/json
ETag: W/"ZfYdV7Meckeip07P//nwjAAADyI7NQ=="
Content-length: 379

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA="
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "id": "0c7fda79-ff00-f57f-37e3-28183b6d09b5",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA=",
    "appointmentClientJoinWebUrl": "https://visit.teams.microsoft.com/webrtc-svc/api/route?tid=a796be92-&convId=19:meeting_=True"
}