邀请家庭成员

最近更新时间:2024-11-01 16:30:32

我的收藏

1. 接口描述

接口请求域名:iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppInviteMember)用于向微信好友发送邀请加入家庭请求。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。
Action
String
公共参数,本接口取值:AppInviteMember。
FamilyId
String
家庭 ID。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。
ShareToken
String
分享 Token,被邀请者可凭此分享 Token 调用 成员加入家庭 接口以加入家庭。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"RequestId": "req_1",
"Action": "AppInviteMember",
"FamilyId":"e0e23a2b33a24652b6**********a1cf",
"AccessToken": "c1******************847e"
}
输出示例:成功
{
"Response": {
"ShareToken": "e0******************a1cf",
"RequestId": "req_1"
}
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。