Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceProperty ServiceQuery Community Steward Details

Query Community Steward Details

Last Updated on : 2023-06-21 07:13:12download

Query the details of the specified community steward. The returned result includes a collection of the mobile phone number, community steward ID and name, image URL, WeChat QR code, management scopes (multiple scopes are separated with semicolons), service skills, service declaration, and house ID.

API address

GET: /v1.0/iot-02/community/housekeeper-detail

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	query	true	The community ID.
hk_id	String	query	true	The ID of the specified steward.

Return parameter

Parameter name	Type	Description
result	HighwayHouseKeeperDetailResponse	The returned result.

Description of result

Parameter name	Type	Description
mobile	String	The mobile phone number.
hk_id	String	The ID of the specified community steward.
housekeeper_name	String	The name of the specified community steward.
face_img_url	String	The URL of the specified image.
wechat_img_url	String	The image of the specified WeChat QR code.
house_name	String	The management scopes, separated with semicolons (`;`).
ability	String	The service skill.
service_motto	String	The service motto.
tree_ids	String	The list of house IDs, separated with commas (,).

Request example

GET: /v1.0/iot-02/community/housekeeper-detail?blockId=1399960265050574848&hkId=1436249349305667679

Return example

{
    "result": {
        "housekeeperName": "James",
        "treeIds": "1399960265050574848",
        "mobile": "13750505050",
        "hkId": "1436249349305667679",
        "serviceMotto": "Work hard",
        "houseName": "Tuya Smart (Test)",
        "faceImgUrl": "https://tuya-biz-data-1254153901.cos.ap-shanghai.myqcloud.com/saas/community/estate_faceImg/1631263461c4ab57ccd48.jpg?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDopcCYgw0qRoyV5qfKjvg2pPkqESnb5zI%26q-sign-time%3D1632281933%3B1632285533%26q-key-time%3D1632281933%3B1632285533%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D2dbfd359f2040c9b62025043b8864eb092ccccbf&imageMogr2/format/jpeg/quality/50/thumbnail/1024x1024/thumbnail/5000000@/auto-orient",
        "wechatImgUrl": "",
        "ability": "8"
    },
    "t": 1632281933206,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Community Steward Reviews

Next DocQuery Community Housekeeper Details