介绍
# Microsoft To Do
使用托管的 OAuth 身份验证访问 Microsoft To Do API。通过完整的 CRUD 操作管理任务列表、任务、清单项和链接资源。
## 快速开始
```bash # List all task lists python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/microsoft-to-do/v1.0/me/todo/lists') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
## Base URL
``` https://gateway.maton.ai/microsoft-to-do/{native-api-path} ```
将 `{native-api-path}` 替换为实际的 Microsoft Graph API 端点路径。网关将请求代理到 `graph.microsoft.com` 并自动注入您的 OAuth 令牌。
## 身份验证
所有请求都需要在 Authorization 头中包含 Maton API 密钥：
``` Authorization: Bearer $MATON_API_KEY ```
**环境变量：** 将您的 API 密钥设置为 `MATON_API_KEY`：
```bash export MATON_API_KEY="YOUR_API_KEY" ```
### 获取您的 API 密钥
1. 在 [maton.ai](https://maton.ai) 登录或创建账户 2. 前往 [maton.ai/settings](https://maton.ai/settings) 3. 复制您的 API 密钥
## 连接管理
在 `https://ctrl.maton.ai` 管理您的 Microsoft To Do OAuth 连接。
### 列出连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=microsoft-to-do&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 创建连接
```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'microsoft-to-do'}).encode() req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 获取连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
**响应：** ```json { "connection": { "connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "microsoft-to-do", "metadata": {} } } ```
在浏览器中打开返回的 `url` 以完成 OAuth 授权。
### 删除连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 指定连接
如果您有多个 Microsoft To Do 连接，请使用 `Maton-Connection` 头指定要使用的连接：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/microsoft-to-do/v1.0/me/todo/lists') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
如果省略，网关将使用默认（最早）的活动连接。
## API 参考
### 任务列表操作
#### 列出任务列表
```bash GET /microsoft-to-do/v1.0/me/todo/lists ```
**响应：** ```json { "value": [ { "id": "AAMkADIyAAAhrbPWAAA=", "displayName": "Tasks", "isOwner": true, "isShared": false, "wellknownListName": "defaultList" } ] } ```
#### 获取任务列表
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId} ```
#### 创建任务列表
```bash POST /microsoft-to-do/v1.0/me/todo/lists Content-Type: application/json
{ "displayName": "Travel items" } ```
**响应 (201 Created)：** ```json { "id": "AAMkADIyAAAhrbPWAAA=", "displayName": "Travel items", "isOwner": true, "isShared": false, "wellknownListName": "none" } ```
#### 更新任务列表
```bash PATCH /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId} Content-Type: application/json
{ "displayName": "Vacation Plan" } ```
#### 删除任务列表
```bash DELETE /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId} ```
成功时返回 `204 No Content`。
### 任务操作
#### 列出任务
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks ```
**响应：** ```json { "value": [ { "id": "AlMKXwbQAAAJws6wcAAAA=", "title": "Buy groceries", "status": "notStarted", "importance": "normal", "isReminderOn": false, "createdDateTime": "2024-01-15T10:00:00Z", "lastModifiedDateTime": "2024-01-15T10:00:00Z", "body": { "content": "", "contentType": "text" }, "categories": [] } ] } ```
#### 获取任务
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId} ```
#### 创建任务
```bash POST /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks Content-Type: application/json
{ "title": "A new task", "importance": "high", "status": "notStarted", "categories": ["Important"], "dueDateTime": { "dateTime": "2024-12-31T17:00:00", "timeZone": "Eastern Standard Time" }, "startDateTime": { "dateTime": "2024-12-01T08:00:00", "timeZone": "Eastern Standard Time" }, "isReminderOn": true, "reminderDateTime": { "dateTime": "2024-12-01T09:00:00", "timeZone": "Eastern Standard Time" }, "body": { "content": "Task details here", "contentType": "text" } } ```
**任务字段：**
| 字段 | 类型 | 描述 | |-------|------|-------------| | `title` | String | 任务的简要描述 | | `body` | itemBody | 任务正文，包含 content 和 contentType (text/html) | | `importance` | String | `low`、`normal` 或 `high` | | `status` | String | `notStarted`、`inProgress`、`completed`、`waitingOnOthers`、`deferred` | | `categories` | String[] | 关联的类别名称 | | `dueDateTime` | dateTimeTimeZone | 截止日期和时间 | | `startDateTime` | dateTimeTimeZone | 开始日期和时间 | | `completedDateTime` | dateTimeTimeZone | 完成日期和时间 | | `reminderDateTime` | dateTimeTimeZone | 提醒日期和时间 | | `isReminderOn` | Boolean | 是否启用提醒 | | `recurrence` | patternedRecurrence | 定期模式 |
#### 更新任务
```bash PATCH /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId} Content-Type: application/json
{ "status": "completed", "completedDateTime": { "dateTime": "2024-01-20T15:00:00", "timeZone": "UTC" } } ```
#### 删除任务
```bash DELETE /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId} ```
成功时返回 `204 No Content`。
### 清单项操作
清单项是任务中的子任务。
#### 列出清单项
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/checklistItems ```
**响应：** ```json { "value": [ { "id": "51d8a471-2e9d-4f53-9937-c33a8742d28f", "displayName": "Create draft", "createdDateTime": "2024-01-17T05:22:14Z", "isChecked": false } ] } ```
#### 创建清单项
```bash POST /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/checklistItems Content-Type: application/json
{ "displayName": "Final sign-off from the team" } ```
#### 更新清单项
```bash PATCH /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/checklistItems/{checklistItemId} Content-Type: application/json
{ "isChecked": true } ```
#### 删除清单项
```bash DELETE /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/checklistItems/{checklistItemId} ```
成功时返回 `204 No Content`。
### 链接资源操作
链接资源将任务连接到外部项目（例如，电子邮件、文件）。
#### 列出链接资源
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources ```
**响应：** ```json { "value": [ { "id": "f9cddce2-dce2-f9cd-e2dc-cdf9e2dccdf9", "webUrl": "https://example.com/item", "applicationName": "MyApp", "displayName": "Related Document", "externalId": "external-123" } ] } ```
#### 创建链接资源
```bash POST /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources Content-Type: application/json
{ "webUrl": "https://example.com/item", "applicationName": "MyApp", "displayName": "Related Document", "externalId": "external-123" } ```
#### 删除链接资源
```bash DELETE /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourceId} ```
成功时返回 `204 No Content`。
## 分页
Microsoft Graph 使用 OData 分页。使用 `$top` 限制结果，使用 `$skip` 进行偏移：
```bash GET /microsoft-to-do/v1.0/me/todo/lists/{todoTaskListId}/tasks?$top=10&$skip=0 ```
当存在更多结果时，响应包含 `@odata.nextLink`：
```json { "value": [...], "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/todo/lists/{id}/tasks?$skip=10" } ```
## 代码示例
### JavaScript
```javascript const response = await fetch( 'https://gateway.maton.ai/microsoft-to-do/v1.0/me/todo/lists', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); const data = await response.json(); ```
### Python
```python import os import requests
response = requests.get( 'https://gateway.maton.ai/microsoft-to-do/v1.0/me/todo/lists', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'} ) data = response.json() ```
## 注意事项
- 任务列表 ID 和任务 ID 是不透明字符串（例如，`AAMkADIyAAAhrbPWAAA=`） - 时间戳默认使用 ISO 8601 格式（UTC） - `dateTimeTimeZone` 类型需要同时包含 `dateTime` 和 `timeZone` 字段 - `wellknownListName` 可以是 `defaultList`、`flaggedEmails` 或 `none` - 任务 `status` 值：`notStarted`、`inProgress`、`completed`、`waitingOnOthers`、`deferred` - 任务 `importance` 值：`low`、`normal`、`high` - 支持 OData 查询参数：`$select`、`$filter`、`$orderby`、`$top`、`$skip` - 重要：使用 curl 命令时，如果 URL 包含括号，请使用 `curl -g` 以禁用 glob 解析 - 重要：将 curl 输出通过管道传递给 `jq` 或其他命令时，在某些 shell 环境中，`$MATON_API_KEY` 等环境变量可能无法正确展开
## 错误处理
| 状态 | 含义 | |--------|---------| | 400 | 缺少 Microsoft To Do 连接或无效请求 | | 401 | 无效或缺少 Maton API 密钥 | | 404 | 未找到资源 | | 429 | 速率受限 | | 4xx/5xx | 来自 Microsoft Graph API 的透传错误 |
### 故障排除：API 密钥问题
1. 检查是否设置了 `MATON_API_KEY` 环境变量：
```bash echo $MATON_API_KEY ```
2. 通过列出连接来验证 API 密钥是否有效：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
### 故障排除：无效的应用名称
1. 确保您的 URL 路径以 `microsoft-to-do` 开头。例如：
- 正确：`https://gateway.maton.ai/microsoft-to-do/v1.0/me/todo/lists` - 错误：`https://gateway.maton.ai/v1.0/me/todo/lists`
## 资源
- [Microsoft To Do API 概述](https://learn.microsoft.com/en-us/graph/api/resources/todo-overview) - [todoTaskList 资源](https://learn.microsoft.com/en-us/graph/api/resources/todotasklist) - [todoTask 资源](https://learn.microsoft.com/en-us/graph/api/resources/todotask) - [checklistItem 资源](https://learn.microsoft.com/en-us/graph/api/resources/checklistitem) - [linkedResource 资源](https://learn.microsoft.com/en-us/graph/api/resources/linkedresource) - [Maton 社区](https://discord.com/invite/dBfFAcefs2) - [Maton 支持](mailto:[email protected])