创建通道实例

为指定 Provider 创建一个通道实例。敏感配置仅在请求中提交，成功响应不会返回明文。

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

调用前准备

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

请求体

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "channel_type": "<CHANNEL_TYPE>",
    "name": "告警通道",
    "config": {
      "endpoint": "<ENDPOINT>"
    },
    "secrets": {
      "token": "<TOKEN>"
    }
  }'

参数说明

路径参数

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

查询参数

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

成功响应

成功时返回 201。data 包含实例 ID、Provider、状态、凭据引用和非敏感配置；请求中的 secrets 不会回显。保存成功不等同于外部服务连接可用，请执行连接测试。

响应示例

{
  "code": 0,
  "data": {
    "id": "inst_01",
    "workspace_id": "ws_01",
    "provider": "wecom",
    "channel_type": "wecom_mail",
    "name": "告警通道",
    "status": "active",
    "credential_ref": "cred_01",
    "config": {
      "endpoint": "https://example.com/hook"
    },
    "created_at": "2026-08-18T01:00:00Z",
    "updated_at": "2026-08-18T01:00:00Z"
  }
}

字段说明

通用字段

字段	类型	说明
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.description	string	实例名称、说明和当前状态。

配置与凭据

字段	类型	说明
data.credential_ref	string	已保存凭据的引用，不是明文密钥。
data.config	object	非敏感配置和标签。
data.labels	object	非敏感配置和标签。

能力与工具

字段	类型	说明
data.capabilities	array of string	可用时返回的回调路径、能力和关联工具。
data.tool_ids	array of string	可用时返回的回调路径、能力和关联工具。
data.callback_path	string	可用时返回的回调路径、能力和关联工具。

状态信息

字段	类型	说明
data.status	string	实例名称、说明和当前状态。

时间、版本与分页

字段	类型	说明
data.created_at	string	创建和最近更新时间，使用 RFC 3339 格式。
data.updated_at	string	创建和最近更新时间，使用 RFC 3339 格式。

错误响应

响应示例

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

字段说明

通用字段

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

后续操作

测试已创建的通道实例以检查连接。

最后更新于 2026 年 9 月 28 日