获取企业微信扫码连接凭据¶
获取企业微信扫码连接凭据。
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/ingress-connections/wecom-qr
调用前准备¶
准备可访问目标工作区并有相应动作权限的个人访问令牌。路径工作区与 X-Workspace-ID 一致。示例使用 jq;变量、对象与状态见公共说明。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/ingress-connections/wecom-qr" \
-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" '
{
"target": {
"kind": "agent",
"workspace_id": $AGENT_WORKSPACE_ID,
"id": $AGENT_ID
}
}
')"
首次返回扫码地址、会话令牌和到期时间;后续携带原 session_token 查询 pending/authorized/expired。会话有效期 5 分钟;遵守 429 的 Retry-After。authorized 返回的 bot_id/secret 供创建 wecom/managed_stream 连接使用,本动作不保存真实连接。令牌和密钥只在受保护客户端处理,不写日志。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
object |
是 |
接收消息的智能体或团队。 |
|
string |
是 |
agent 或 team。 |
|
string |
是 |
目标所属工作区;团队在当前工作区,智能体在当前或系统工作区。 |
|
string |
是 |
目录返回的目标 ID。 |
|
string |
否 |
首次省略;继续查询时保留同一工作区、账号、目标返回的原值。 |
成功响应¶
{
"code": 0,
"data": {
"status": "pending",
"session_token": "opaque_example",
"qr_url": "https://work.weixin.qq.com/example",
"expires_at": "2026-11-11T00:05:00Z"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
|
object |
结果对象,字段见公共对象说明。 |
错误响应¶
按 HTTP 状态、业务结果和错误字段处理,见错误与环境。来源与版本冲突时读取当前状态,不替换身份、资源或请求 ID 自动重试。
最后更新于