创建消息接收连接¶
创建消息接收连接。
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/ingress-connections
调用前准备¶
准备可访问目标工作区并有相应动作权限的个人访问令牌。路径工作区与 X-Workspace-ID 一致。示例使用 jq;变量、对象与状态见公共说明。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/ingress-connections" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary "$(jq -n --arg AGENT_WORKSPACE_ID "$AGENT_WORKSPACE_ID" --arg AGENT_ID "$AGENT_ID" --arg AGENT_MODEL "$AGENT_MODEL" --slurpfile MANAGED_CREDENTIALS_FILE "$MANAGED_CREDENTIALS_FILE" '
{
"target": {
"kind": "agent",
"workspace_id": $AGENT_WORKSPACE_ID,
"id": $AGENT_ID
},
"provider": "slack",
"channel_type": "slack_app",
"receive_mode": "managed_stream",
"agent_model": $AGENT_MODEL,
"managed_stream": $MANAGED_CREDENTIALS_FILE[0]
}
')"
示例读取本地托管凭据 JSON 对象。Slack 创建需 app_id/app_token/bot_token;飞书需 app_id/app_secret;企业微信 AI Bot 需 bot_id/secret。创建后的托管连接进入 starting;回调连接初始停用,须另行校验;邮件模式等待首条输入。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
object |
是 |
接收消息的智能体或团队。 |
|
string |
是 |
agent 或 team。 |
|
string |
是 |
目标所属工作区;团队在当前工作区,智能体在当前或系统工作区。 |
|
string |
是 |
目录返回的目标 ID。 |
|
string |
是 |
从能力列表选择平台。 |
|
string |
是 |
与平台及接收模式匹配的通道类型。 |
|
string |
是 |
managed_stream、callback 或 mail_polling。 |
|
string |
条件必填 |
agent 目标须指定可用模型;团队由成员配置决定。 |
|
object |
条件必填 |
托管模式提供所选平台凭据;不能同时提供其他模式对象。 |
|
string |
条件必填 |
回调模式引用当前工作区已有、启用并支持入站的通道实例。 |
|
string |
条件必填 |
邮件轮询引用相应通道实例,不能与 callback 或 managed_stream 混用。 |
成功响应¶
{
"code": 0,
"data": {
"id": "ingress_example",
"workspace_id": "workspace_example",
"target": {
"kind": "agent",
"workspace_id": "workspace_example",
"id": "agent_example"
},
"provider": "slack",
"channel_type": "slack_app",
"receive_mode": "managed_stream",
"agent_model": "model_example",
"association_version": 1,
"connected_by_user_id": "user_example",
"enabled": true,
"account_identity": "slack:app:app_example",
"config_version": 1,
"desired_state": "enabled",
"observed_state": "starting",
"created_at": "2026-11-11T00:00:00Z",
"updated_at": "2026-11-11T00:00:00Z"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
|
object |
结果对象,字段见公共对象说明。 |
错误响应¶
按 HTTP 状态、业务结果和错误字段处理,见错误与环境。来源与版本冲突时读取当前状态,不替换身份、资源或请求 ID 自动重试。