The content of this page has been automatically translated by AI. If you encounter any problems while reading, you can view the corresponding content in Chinese.
Help & Documentation>IoT Explorer>Application Side API>Family Management>Invite Family Members

Invite Family Members

Last updated: 2025-04-30 15:41:07

On this page:

1. API Description

api request domain name: iot.cloud.tencent.com/api/exploreropen/tokenapi. This interface (AppInviteMember) is used to send a request to a WeChat friend to inviting others to join family.

2. Input Parameters

Name
Type
Required
Description
AccessToken
String
Yes
Common parameter. AccessToken is used for user authentication of a logged-in user.
RequestId
String
Yes
Common parameter. Unique request ID can be generated manually. It is recommended to use uuid. When locating issues, you need to provide the RequestId for the request.
Action
String
Yes
Common parameter. This interface takes values: AppInviteMember.
FamilyId
String
Yes
Family ID.

3. Output Parameters

Name
Type
Description
RequestId
String
Common parameter. Unique request ID, same as the input parameter. When locating issues, you need to provide the RequestId for the request.
ShareToken
String
Share the Token. The invitee can use this Token to make an API call to the Member Join Family API to join the family.

4. Example

Input Example
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"
}
Output sample: successful
{
    "Response": {
        "ShareToken": "e0******************a1cf",
        "RequestId": "req_1"
    }
}

5. Error Code

Error Code
Description
InternalError
Internal error.
InvalidParameterValue
Invalid parameter value.
InvalidParameterValue.InvalidAccessToken
The Token is invalid.

中国站 - English