通过

创建订阅

  • 项目

订阅侦听器应用程序，在数据发生更改时接收通知。

权限

调用此 API 需要以下权限之一。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型 权限（从最低特权到最高特权）
委派（工作或学校帐户） Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委派（个人 Microsoft 帐户） Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All
应用程序 Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All

HTTP 请求

POST /subscriptions

响应

如果成功，此方法在响应正文中返回 201 Created 响应代码和 subscription 对象。

示例

请求

下面是在用户的驱动器内容更改时请求发送通知的示例。

POST /subscriptions
Content-type: application/json

{
 "changeType": "updated",
 "notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
 "resource": "/me/drive/root",
 "expirationDateTime": "2018-01-01T11:23:00.000Z",
 "clientState": "client-specific string"
}

响应

如果订阅已添加，那么返回的 201 Created 响应中包含新建的订阅对象。

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

{
    "id": "1039149811asbc",
    "resource": "/me/drive/root",
    "changeType": "updated",
    "clientState": "client-specific string",
    "notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
    "expirationDateTime": "2016-01-01T11:23:00.000Z"
}

订阅验证

创建新订阅前，Microsoft Graph 会向订阅新建请求中的 URL 发送请求。 为了响应此请求，服务必须返回验证密钥。

如果服务无法以这种方式验证请求，将无法创建订阅。

有关详细信息，请参阅处理 Webhook 验证请求。

错误响应

请参阅错误响应，详细了解错误返回方式。