删除通道实例¶

删除一个通道实例及其关联凭据。删除后不能再使用该实例发送消息或接收回调。

DELETE https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/channels/{provider}/instances/{instance_id}

调用前准备¶

先查询通道实例详情，确认要删除的实例。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、通道 Provider 标识和实例 ID。

请求参数¶

请求示例

curl -X DELETE "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances/$INSTANCE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

字段	类型	必填	说明
`workspace_id`	string	是	工作区 ID。
`provider`	string	是	通道 Provider 标识。
`instance_id`	string	是	通道实例 ID。

成功响应¶

成功时返回 200 和被删除的实例快照。该操作会删除关联凭据，无法通过该实例恢复。

响应示例

{
  "code": 0,
  "data": {
    "id": "inst_01",
    "workspace_id": "ws_01",
    "provider": "wecom",
    "channel_type": "wecom_mail",
    "name": "告警通道",
    "status": "active",
    "credential_ref": "cred_01"
  }
}

字段说明

通用字段

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

基础信息

字段	类型	说明
`data.id`	string	已删除实例的 ID 和所属工作区。
`data.workspace_id`	string	已删除实例的 ID 和所属工作区。
`data.provider`	string	Provider、通道类型和删除前状态。
`data.channel_type`	string	Provider、通道类型和删除前状态。
`data.name`	string	实例名称和已删除凭据的引用。

配置与凭据

字段	类型	说明
`data.credential_ref`	string	实例名称和已删除凭据的引用。

状态信息

字段	类型	说明
`data.status`	string	Provider、通道类型和删除前状态。

错误响应¶

响应示例

{
  "code": 3,
  "message": "channel instance not found"
}

字段说明

通用字段

字段	类型	说明
`code`	integer	错误代码。
`message`	string	面向调用者的错误信息。

后续操作¶

如需继续使用该 Provider，请创建通道实例。

最后更新于 2026 年 9 月 6 日