简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

家庭分享管理

更新时间:2021-07-30 04:03:17下载pdf

添加分享

接口说明

生成家庭分享票据,用于邀请成员加入家庭。

接口地址

action: sharing.homeTicket

params请求参数

参数名 类型 说明 是否必填
home_id Long 家庭id
sharer String 分享人账号
receiver String 接受人账号,不填则为二维码分享
app_schema String 涂鸦渠道标识符,填入 cloud 即可

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节)
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 结果

result说明

参数名 类型 说明
sharing_id String 分享id
sharing_ticket String 分享票据,一次有效
expire_time Long 失效时间,单位秒

请求示例

{
	"action": "sharing.homeTicket",
	"params": {
		"home_id": 10001,
    "sharer": "ay15309353754999xY2T",
    "app_schema": "xxxxxx"
	}
}

响应示例

{
    "result": {
      "sharing_id": 5003,
      "sharing_ticket": "3ce76bc4f8ef36f5a709043b49175ad8",
      "expire_time": 300
    },
    "t":1540799929837,
    "success": true
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误
1106 权限非法

家庭分享票据校验

接口说明

校验家庭分享的临时票据是否有效。

接口地址

action: sharing.homeTicketVerification

params请求参数

参数名 类型 说明 是否必填
sharing_ticket String 分享票据

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节)
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 结果

result说明

参数名 类型 说明
sharing_id String 分享id
sharing_ticket String 分享票据,一次有效
expire_time Long 失效时间,单位秒

请求示例

{
	"action": "sharing.homeTicketVerification",
	"params": {
    "sharing_ticket": "3ce76bc4f8ef36f5a709043b49175ad8"
	}
}

响应示例

{
    "result": {
      "sharing_id": 5003,
      "sharing_ticket": "3ce76bc4f8ef36f5a709043b49175ad8",
      "expire_time": 300
    },
    "t":1540799929837,
    "success": true
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误
1106 权限非法
2703 分享票据过期

加入分享

接口说明

受邀人确认加入家庭分享。

接口地址

action: sharing.homeConfirm

请求参数

参数名 类型 说明 是否必填
sharing_id Long 分享ID
sharing_ticket String 分享票据
receiver String 接受者账号
app_schema String 涂鸦渠道标识符,填入 cloud 即可

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节)
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 确认结果

请求示例

{
	"action": "sharing.homeConfirm",
	"params": {
		"sharing_id": 5003,
    "sharing_ticket": "3ce76bc4f8ef36f5a709043b49175ad8",
    "receiver": "ay15309353754xxxxxx",
    "app_schema": "xxxxxxx"
	}
}

响应示例

{
    "success":true,
    "t":1540799929837,
    "result":true
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误
1106 权限不足
2703 分享票据过期

取消分享

接口说明

管理员取消分享邀请。

接口地址

action: sharing.homeCancel

请求参数

参数名 类型 说明 是否必填
sharing_id Long 分享邀请ID

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节)
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 结果

请求示例

{
	"action": "sharing.homeCancel",
	"params": {
		"sharing_id": 5003
	}
}

响应示例

{
    "success":true,
    "t":1540799929837,
    "result":true
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误
1106 权限不足