使用 Microsoft Graph 中的 Microsoft Bookings API

  • 项目

重要

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

Microsoft Bookings 可让企业组织和小型企业所有者以最少量的设置管理客户预订和信息。 企业所有者可以创建一个或多个企业，每个企业都提供一组服务。 所有者可以设置员工，并指定每名员工执行的服务。 客户可以通过在线或移动应用预约该企业中的特定服务。 Bookings 可确保为企业、员工和相关客户保持最新的约会时间。

就编程而言，Bookings API 中的 bookingBusiness 涉及以下对象：

使用 Bookings REST API

第一次客户预约之前，请完成以下步骤。 确保为相应的操作提供适当的访问令牌。

  1. 确保企业具有 Microsoft 365 商业高级版订阅。
  2. 通过向实体集发送 POST 操作来创建新的 bookingBusiness。 至少应为新企业指定客户将看到的名称：
POST https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Contoso"
}

使用 POST 响应中返回的新 bookingBusiness 的 id 属性继续自定义企业设置，并为企业添加员工和服务。

  1. 为企业添加各个员工：
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/staffMembers
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Dana Swope",
    "emailAddress": "danas@contoso.com",
    "role": "externalGuest"
}
  1. 定义企业提供的每项服务：
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/services
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Bento"
}
  1. 发布企业的日程安排页面，让客户和企业经营者开始预约：
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/publish
Authorization: Bearer {access token}

通常，若要列出 Microsoft 365 租户中的所有预订企业：

GET https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}

常见用例

下表列出了 Bookings API 中的常见企业操作。

用例 REST 资源 另请参阅
创建、获取、更新或删除企业 bookingBusiness bookingBusiness 的方法
更新日程安排策略 bookingSchedulingPolicy 更新 bookingBusiness
添加、获取、更新或删除员工 bookingStaffMember bookingStaffMember 的方法
添加、获取、更新或删除服务 bookingService bookingService 的方法
发布或取消发布日程安排页面 bookingBusiness 发布
取消发布
创建、获取、更新、删除或取消约会 bookingAppointment bookingAppointment 的方法
获取某个日期范围内的约会 bookingBusiness 列出 Bookings 日历视图
获取货币 bookingCurrency bookingCurrency 的方法

相关内容