删除邮件工具连接

删除当前工作区保存的邮件工具连接和关联凭据。即使当前没有连接,接口也会返回已断开的状态。

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

调用前准备

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

此接口的请求体必须为空。

请求参数

curl -X DELETE "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
  }
}

成功时返回 200。断开后,后续邮件工具调用不能继续使用已删除的连接凭据。

响应字段如下。

字段

类型

说明

code

integer

成功时为 0。

字段

类型

说明

tool_id

string

邮件内置工具标识和提供方。

provider

string

邮件内置工具标识和提供方。

status

string

断开后为 disconnected。

requires_reconnect

boolean

断开后为 false。

错误响应

{
  "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)

**常见原因:**邮件连接服务或授权依赖暂不可用。**建议操作:**稍后重试。

后续操作

查询工具标签,确认目标已不再出现。

最后更新于