测试未保存的通道配置¶

在不创建实例的情况下验证通道配置。此接口当前仅支持 wecom Provider 的 wecom_mail 通道类型。

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

调用前准备¶

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID，以及待测试的通道配置与密钥。

路径中的 provider 必须为 wecom。请求体与创建通道实例相同；channel_type 必须为 wecom_mail，所需的 config 与 secrets 由该通道类型决定。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/channels/wecom/instances/test" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "channel_type": "wecom_mail",
    "name": "邮件通道",
    "secrets": {
      "<KEY>": "<VALUE>"
    }
  }'

参数说明

路径参数

字段	类型	必填	说明
`workspace_id`	string	是	工作区 ID。
`provider`	string	是	必须为 wecom。

查询参数

字段	类型	必填	说明
`channel_type`	string	是	必须为 wecom_mail。
`name`	string	是	实例名称。
`description`	string	否	实例说明。
`config`	object	否	非敏感配置。
`secrets`	object	按通道类型要求	密钥和其他敏感配置。
`visibility`	string	否	可见范围。
`labels`	object	否	标签键值对。

成功响应¶

成功时返回 200。此接口不会创建实例或保存 secrets；结果中的 instance 是本次待测试配置的非敏感投影。

响应示例

{
  "code": 0,
  "data": {
    "instance": {
      "workspace_id": "ws_01",
      "provider": "wecom",
      "channel_type": "wecom_mail",
      "name": "邮件通道",
      "status": "draft"
    },
    "ok": true,
    "status": "passed",
    "last_test_status": "passed",
    "last_tested_at": "2026-08-18T01:00:00Z"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	integer	成功处理测试请求时为 0，即使连接测试本身失败。

基础信息

字段	类型	说明
`data.instance`	object	待测试配置的非敏感实例投影。
`data.ok`	boolean	连接测试是否通过。
`data.worker_id`	string	可用时返回的执行方和请求标识。
`data.request_id`	string	可用时返回的执行方和请求标识。
`data.suggestion`	string	可操作的修复建议；可用时返回。

状态信息

字段	类型	说明
`data.status`	string	本次和最近一次测试状态。
`data.last_test_status`	string	本次和最近一次测试状态。
`data.last_test_error`	string	测试失败时的错误信息。
`data.error_code`	string	服务归类的错误代码、阶段和类别。
`data.error_stage`	string	服务归类的错误代码、阶段和类别。
`data.error_category`	string	服务归类的错误代码、阶段和类别。
`data.provider_error_code`	string	Provider 返回的错误信息；可用时返回。
`data.provider_error_message`	string	Provider 返回的错误信息；可用时返回。

时间、版本与分页

字段	类型	说明
`data.last_tested_at`	string	测试时间，使用 RFC 3339 格式。

错误响应¶

响应示例

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

字段说明

通用字段

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

后续操作¶

测试通过后，创建通道实例保存配置。

最后更新于 2026 年 9 月 8 日