1. API Description
api request domain name:
iot.cloud.tencent.com/api/exploreropen/tokenapi.
This interface (AppCreateFamily) is used to create a 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. Locating issues, you need to provide the RequestId for the request. |
Action | String | Yes | Common parameter. This interface takes values: AppCreateFamily. |
Name | String | Yes | Family name. |
Address | String | Yes | Residence address. |
3. Output Parameter
Name | Type | Description |
RequestId | String | Common parameter. Unique request ID is the same as the input parameter. Locating issues, you need to provide the RequestId for the request. |
FamilyId | String | The Family ID successfully created. |
4. Samples
Input Example
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppCreateFamily","Name": "family_name","Address": "family_address","AccessToken": "c1******************847e"}
Output sample: successful
{"Response": {"Data": {"FamilyId": "e0e23a2b33a24652b6**********a1cf"},"RequestId": "req_1"}}
5. Error Code
Error Code | Description |
InternalError | Internal error. |
InvalidParameterValue | Invalid parameter value. |
InvalidParameterValue.InvalidAccessToken | The Token is invalid. |