Skip to main content
POST
创建邀请
本接口要求 Admin Key 具备 org:write 作用域,且调用时 key 持有者仍是组织管理员(否则返回 403 owner_not_admin)。昵称仅支持中文、字母与数字(1-32 字符)。未填昵称时系统自动生成:邮箱邀请取邮箱地址中 @ 前的部分并去除不支持的字符;手机号邀请统一使用默认昵称 user,不会使用手机号生成。

授权

Authorization
string
header
必填

Authorization 请求头携带 Admin API secret 作为 Bearer 令牌,格式为 Bearer sk-admin-***。Admin Key 可在「控制台 → 组织管理 → Admin API Keys」创建。

请求体

application/json
invitee
string
必填

手机号或邮箱地址,取决于 invitee_type。

示例:

"ops@example.com"

invitee_type
enum<string>
必填

联系方式类型:phone 手机号、email 邮箱。

可用选项:
phone,
email
示例:

"email"

role
enum<string>
必填

被邀请人加入后的组织角色:admin 或 member。

可用选项:
admin,
member
示例:

"member"

nick_name
string

被邀请人展示昵称(1-32 个字符,仅支持中文、字母与数字)。缺省时自动生成:邮箱邀请取邮箱地址中 @ 前的部分并去除不支持的字符;手机号邀请统一使用默认昵称,不基于手机号生成。

响应

已创建的邀请(被邀请人已脱敏)。

code
string
必填

邀请码。明文返回,可用于精确查询同一邀请。

role
enum<string>
必填

被邀请人加入后的组织角色:admin 或 member。

可用选项:
admin,
member
status
enum<string>
必填

邀请状态:pending 待接受、accepted 已接受。

可用选项:
pending,
accepted
invitee
string

脱敏后的被邀请人联系方式:邮箱保留 local part 首字母(如 a***@x.com),手机号保留前 3 位与后 4 位、中段打码(如 138****1234)。列表、详情与创建接口三处均按此脱敏。

nick_name
string

被邀请人展示昵称。