创建邀请
POST
/web/v1/workspaces/{workspaceBizId}/invitations JWT创建新的工作空间加入邀请。被邀请人会收到通知,可以接受或拒绝。
鉴权
Auth Chain: WEB Chain — 需要
Authorization: Bearer <jwt>系统注入的请求头(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx)、X-Request-Id(Gateway)
请求参数
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceBizId | String | Required | path | 工作空间业务 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
}
}响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
bizId | String | 邀请唯一业务 ID |
workspaceBizId | String | 目标工作空间业务 ID |
workspaceName | String | 目标工作空间显示名称 |
inviterBizId | String | 邀请人账户业务 ID |
inviterName | String | 邀请人显示名称 |
inviteeEmail | String | 被邀请人邮箱地址 |
inviteeAccountBizId | String | 被邀请人账户 ID(若已注册) |
inviteeAccountName | String | 被邀请人显示名称(可为空) |
invitationStatus | Object | 状态枚举:PENDING、ACCEPTED、CANCELLED、DECLINED、EXPIRED |
message | String | 邀请消息 |
expiresAt | String | ISO 8601 过期时间 |
acceptedAt | String | ISO 8601 接受时间(可为空) |
createdAt | String | ISO 8601 创建时间 |
canAccept | Boolean | 邀请是否仍可接受 |
错误响应
未授权 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权限。