查询邮件工具连接

查询当前工作区的邮件工具连接状态。该接口不返回密码。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/tools/mail/{provider}/connect

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数

调用示例

curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/tools/mail/qq/connect" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

参数	类型	是否必填	说明
workspace_id	string	是	当前工作区 ID。
provider	string	是	要查询的邮件提供方：qq 或 wecom。

成功响应

响应示例

{
  "code": 0,
  "data": {
    "tool_id": "moi.qq.mail",
    "provider": "qq",
    "status": "disconnected",
    "requires_reconnect": false
  }
}

{
  "code": 0,
  "data": {
    "tool_id": "moi.qq.mail",
    "provider": "qq",
    "email": "user@example.com",
    "credential_ref": "cred_01",
    "status": "connected",
    "connected_at": "2026-01-02T15:04:05Z",
    "requires_reconnect": false
  }
}

字段说明

成功时返回 200。未保存连接时，接口返回 disconnected 状态。

连接可用时：

响应字段如下。

通用字段

字段	类型	说明
code	integer	成功时为 0。

基本信息

字段	类型	说明
tool_id	string	邮件内置工具标识和提供方。
provider	string	邮件内置工具标识和提供方。
email	string	已保存的邮箱地址；未连接或凭据不可用时可能不返回。
status	string	connected、disconnected 或 needs_reconnect。
credential_ref	string	凭据引用和连接时间；未连接时不返回。
connected_at	string	凭据引用和连接时间；未连接时不返回。
requires_reconnect	boolean	凭据不可用时为 true。

错误响应

响应示例

{
  "code": 2,
  "message": "<错误信息>"
}

字段说明

常见 HTTP 错误

通用字段

字段	类型	说明
400	2（INVALID_ARGUMENT）	常见原因：provider 或工作区 ID 无效。建议操作：provider 仅使用 qq 或 wecom，并检查路径参数。
401	6（UNAUTHENTICATED）	**常见原因：**缺少有效身份凭据。**建议操作：**检查 API Key。
403	5（PERMISSION_DENIED）	**常见原因：**当前身份没有读取工具连接的权限。**建议操作：**检查工作区授权。
503	15（UNAVAILABLE）	**常见原因：**邮件连接服务或授权依赖暂不可用。**建议操作：**稍后重试。

后续操作

需要修改时更新工具。返回列表时查询工具标签。

最后更新于 2026 年 9 月 11 日