1. API Description
api request domain name:
iot.cloud.tencent.com/api/exploreropen/tokenapi.
This interface (AppGetFamilyMemberList) is used to obtain the family member list.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. Locating issues, you need to provide the RequestId for the request. |
Action | String | Yes | Common parameter. this interface takes values: AppGetFamilyMemberList. |
Offset | Int | No | The offset of the data you want to query. |
Limit | Int | No | The total limit of data you want to query. Maximum returns 50 items. |
FamilyId | String | Yes | Family ID needed to get. |
3. Output Parameters
Name | Type | Description |
RequestId | String | Common parameter. Unique request ID, same as the input parameter. Locating issues, you need to provide the RequestId for the request. |
Total | Int | Total number of family members returned. |
MemberList | Array |
4. Samples
Input Example
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"FamilyId": "f_b3ac7e6b1cd24392b41e**********5a","Offset": 0,"Limit": 100,"Action": "AppGetFamilyMemberList","RequestId": "hojkE0Hx88","AccessToken": "3c******************40c5"}
Output example: successful
{"MemberList": [{"UserID": "7267","NickName": "deny","Avatar": "https://wx.qlogo.cn/mmopen/vi_32/V2kIBBE35phMrFKu5sra16bzpUuPtokyWTbMRPt7bRGBjx4fEqQrZxoDYyxNVbtkXMosuxQeIqiafIZJ8ADr8cw/132","Role": 1}],"Total": 1,"RequestId": "hojkE0Hx88"}
5. Error Code
Error Code | Description |
InternalError | Internal error. |
InvalidParameterValue | Invalid parameter value. |
InvalidParameterValue.InvalidAccessToken | The Token is invalid. |