Skip to content

创建邀请

POST/web/v1/workspaces/{workspaceBizId}/invitations JWT

创建新的工作空间加入邀请。被邀请人会收到通知,可以接受或拒绝。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 系统注入的请求头(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx)、X-Request-Id(Gateway)

请求参数

NameTypeRequiredInDescription
workspaceBizIdStringRequiredpath工作空间业务 ID

请求体

json
{
  "inviteeEmail": "invitee@example.com",
  "message": "欢迎加入我们的工作空间",
  "expirationDays": 7
}

请求示例

json
{
  "inviteeEmail": "newuser@example.com",
  "message": "Welcome to our team",
  "expirationDays": 7
}

成功响应

状态码: 201 Created

201 Created 201
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2001",
  "message": "CREATED",
  "data": {
    "bizId": "inv_abc123def456",
    "workspaceBizId": "WS_INVITE_TEST_001",
    "workspaceName": "测试工作空间",
    "inviterBizId": "ACC_OWNER_INVITE_001",
    "inviterName": "所有者用户",
    "inviteeEmail": "invitee@example.com",
    "inviteeAccountBizId": "ACC_INVITEE_001",
    "inviteeAccountName": null,
    "invitationStatus": {
      "value": 10011001,
      "name": "PENDING",
      "code": "PENDING"
    },
    "message": "欢迎加入我们的工作空间",
    "expiresAt": "2026-03-29T10:30:00Z",
    "acceptedAt": null,
    "createdAt": "2026-03-22T10:30:00Z",
    "canAccept": true
  }
}

响应字段

字段类型说明
bizIdString邀请唯一业务 ID
workspaceBizIdString目标工作空间业务 ID
workspaceNameString目标工作空间显示名称
inviterBizIdString邀请人账户业务 ID
inviterNameString邀请人显示名称
inviteeEmailString被邀请人邮箱地址
inviteeAccountBizIdString被邀请人账户 ID(若已注册)
inviteeAccountNameString被邀请人显示名称(可为空)
invitationStatusObject状态枚举:PENDING、ACCEPTED、CANCELLED、DECLINED、EXPIRED
messageString邀请消息
expiresAtStringISO 8601 过期时间
acceptedAtStringISO 8601 接受时间(可为空)
createdAtStringISO 8601 创建时间
canAcceptBoolean邀请是否仍可接受

错误响应

未授权 401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
冲突 409
{
  "success": false,
  "code": "WORKSPACE.DUPLICATE_PENDING_INVITATION",
  "message": "A pending invitation already exists for this email"
}

说明

  • 成功时返回 HTTP 201,响应码为 "2001"
  • expirationDays 未提供时默认为 7 天。
  • 对同一邮箱重复发送待处理邀请返回 409 WORKSPACE.DUPLICATE_PENDING_INVITATION
  • 需要 workspace:invitation:write 权限。

SlaunchX Internal Documentation