1. API Description
api request domain name:
iot.cloud.tencent.com/api/exploreropen/tokenapi.
This interface (AppJoinFamily) is used for member join family.2. Input Parameter
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: AppJoinFamily. |
ShareToken | String | Yes | Share Token, generated by the family administrator calling Invite Family Member. The invitee can join the appropriate family with this Share Token. |
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. |
4. Example
Input Example
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "550e8400-e29b-41d4-a716-446655440000","Action": "AppJoinFamily","ShareToken":"e0******************a1cf","AccessToken": "c1******************847e"}
Output Example: successful
{"Response": {"RequestId": "550e8400-e29b-41d4-a716-446655440000"}}
5. Error Code
Error Code | Description |
InternalError | Internal error. |
InvalidParameterValue | Invalid parameter value. |
InvalidParameterValue.InvalidAccessToken | The Token is invalid. |