Skip to content

邀请家庭成员

接口地址:/v2/family/enduserapi/inviteFamilyMember

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

邀请家庭成员

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
fid家庭idquerytruestring
invalidTime邀请失效时间,毫秒时间戳querytrueinteger(int64)
memberName成员名称querytruestring
memberRole家庭成员角色:
1-家庭创建者,只有在自己创建的家庭中会拥有此角色
2-家庭管理员
3-家庭普通成员
querytrueinteger(int32)
acceptTime接受邀请时间queryfalsestring(date-time)
email被邀请人邮箱queryfalsestring
inviteTime邀请时间queryfalsestring(date-time)
phone被邀请人手机号queryfalsestring
uid被邀请人uidqueryfalsestring

响应状态:

状态码说明schema
200邀请家庭成员成功返回注册码响应数据
5019手机号格式不正确
5145时间戳格式不正确
5636请输入家庭ID
5638普通成员没有权限
5645请输入成员角色
5646请输入失效时间
5647失效时间不能小于当前时间
5648请输入成员名称
5649成员名称超长,请输入256字符以内的成员名称
5650成员名称已存在,请重新输入
5651请输入被邀请用户信息
5653用户已被邀请,请勿重复邀请

响应参数:

参数名称参数说明类型schema
code响应状态码integer(int32)integer(int32)
data响应数据object
extMsg扩展消息string
msg响应消息string

响应示例:

javascript
{
	"code": 0,
	"data": {},
	"extMsg": "",
	"msg": ""
}