在服务器端调用微软office接口,Office 365 服务通信 API 参考

Office 365 服务通信 API 参考

2021/8/11

本文内容

重要

Microsoft Graph 中的服务运行状况和通信 API 现已推出。 Microsoft Graph API 替换本文中所述的服务通信 API。 我们将从 2021 年 12 月 17 日开始停用旧版服务通信 API。 有关新 Microsoft Graph API 的详细信息，请参阅通过 Microsoft Graph 访问服务运行状况和通信的概述。

Office 365 服务通信 API V2 可用于访问以下数据：

获取服务：获取已订阅服务的列表。

获取当前状态：获取当前正在进行的服务事件的实时视图。

获取历史记录状态：获取服务事件的历史视图。

获取消息：查找事件和消息中心通信。

目前，Office 365 服务通信 API 包含 Office 365、Yammer、Dynamics CRM 和 Microsoft Intune 云服务的数据。

基础知识

此 API 的根 URL 包含将操作范围限定为一个租户的租户标识符：

https://manage.office.com/api/v1.0/{tenant_identifier}/ServiceComms/{operation}

借助 Office 365 服务通信 API 这项 REST 服务，可开发使用任何 Web 语言和宿主环境(支持 HTTPS 和 X.509 证书)的解决方案。 此 API 依赖 Microsoft Azure Active Directory 和 OAuth2 协议进行身份验证和授权。 若要在应用程序中访问此 API，必须先在 Azure AD 中注册应用程序，并为它配置适当范围的权限。 这样，应用程序便能请求获取调用此 API 所需的 OAuth2 访问令牌。 若要详细了解如何在 Azure AD 中注册和配置应用程序，请参阅 Office 365 管理 API 入门。

所有 API 请求都要求，授权 HTTP 头中必须有从 Azure AD 中获取的包含 ServiceHealth.Read 声明的有效 OAuth2 JWT 访问令牌；且租户标识符必须与根 URL 中的租户标识符一致。

Authorization: Bearer {OAuth2 token}

请求标头

以下是所有 Office 365 服务通信 API 操作支持的请求头。

头

说明

Accept(可选)

以下是可接受的响应表示形式：

application/json;odata.metadata=full

application/json;odata.metadata=minimal

[The default if header not specified] application/json;odata.metadata=none

Authorization(必需)

请求的授权令牌(持有者 JWT Azure AD 令牌)。

响应标头

以下是所有 Office 365 服务通信 API 操作返回的响应头：

头

说明

Content-Length

响应正文长度。

Content-Type

响应表示形式：

application/json

application/json;odata.metadata=full

application/json;odata.metadata=minimal

application/json;odata.metadata=none

odata.streaming=true

Cache-Control

用于指定请求/响应链上的所有缓存机制都必须遵守的指令。

Pragma

实现专属行为。

Expires

客户端何时应让资源到期。

X-Activity-Id

服务器生成的活动 ID。

OData-Version

受支持的 OData 版本 (4.0)。

Date

服务器发送响应的日期 (UTC)。

X-Time-Taken

响应生成耗时(以毫秒为单位)。

X-Instance-Name

用于生成响应的 Azure 实例的标识符(用于调试目的)。

Server

用于生成响应的服务器(用于调试目的)。

X-ASPNET-Version

生成响应的服务器使用的 ASP.Net 版本(用于调试目的)。

X-Powered-By

生成响应的服务器使用的技术(用于调试目的)。

下文介绍了 Office 365 服务通信 API 操作。

获取服务

返回已订阅服务的列表。

信息

服务

说明

路径

/Services

查询选项

$select

选择一部分属性。

响应

“Service”实体列表

“Service”实体包含“Id”(String)、“DisplayName”(String) 和“FeatureNames”(String 列表)。

示例请求

GET https://manage.office.com/api/v1.0/contoso.com/ServiceComms/Services

Authorization: Bearer {AAD_Bearer_JWT_Token}

示例响应

{

"value": [

{

"Id": "Exchange",

"DisplayName": "Exchange Online",

"FeatureNames": [

"Sign-in",

"E-Mail and calendar access",

"E-Mail timely delivery",

"Management and Provisioning",

"Voice mail"

]

},

{

"Id": "Lync",

"DisplayName": "Lync Online",

"FeatureNames": [

"Audio and Video",

"Federation",

"Management and Provisioning",

"Sign-In",

"All Features",

"Dial-In Conferencing",

"Online Meetings",

"Instant Messaging",

"Presence",

"Mobility"

]

}

]

}

获取当前状态

返回过去 24 小时的服务状态。

备注

服务响应将包含过去 24 小时内的状态和所有事件。 返回的 StatusDate 或 StatusTime 值将正好是过去 24 小时。 若要获取特定事件的最近一次更新信息, 请使用 "获取消息" 功能并从与事件 ID 匹配的响应记录中读取 LastUpdatedTime 值。

信息

服务

说明

路径

/CurrentStatus

筛选器