English
English
简体中文
Contact Us
Register
Log In

Query Community Steward Details

Last Updated on : 2023-01-29 07:00:03download

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 nameTypeINRequiredDescription
block_idStringquerytrueThe community ID.
hk_idStringquerytrueThe ID of the specified steward.

Return parameter

Parameter nameTypeDescription
resultHighwayHouseKeeperDetailResponseThe returned result.

Description of result

Parameter nameTypeDescription
mobileStringThe mobile phone number.
hk_idStringThe ID of the specified community steward.
housekeeper_nameStringThe name of the specified community steward.
face_img_urlStringThe URL of the specified image.
wechat_img_urlStringThe image of the specified WeChat QR code.
house_nameStringThe management scopes, separated with semicolons (;).
abilityStringThe service skill.
service_mottoStringThe service motto.
tree_idsStringThe 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.