Share via

创建 virtualAppointment (已弃用)

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

警告

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 集合 虚拟约会的客户端信息，包括姓名、电子邮件和短信电话号码。 可选。
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"
}