海康云眸·社区 API
  1. 物业人员管理
海康云眸·社区 API
  • 产品介绍
  • 开发指南
  • 能力概览
  • 错误码表
  • 快速入门
    • 接口调用说明
    • 生成授权凭证
      POST
  • API列表
    • 消息类型定义
    • 社区管理
      • 新增社区
      • 删除社区
      • 修改社区
      • 查询社区
    • 房屋管理
      • 新增楼栋
      • 删除楼栋
      • 新增单元
      • 删除单元
      • 新增户室
      • 删除户室
      • 根据编号查询户室
      • 根据ID查询户室
      • 查询社区下的房屋
      • 查询社区下的楼栋
      • 查询楼栋下的单元
      • 查询单元下的房屋
    • 住户人人员管理
      • 新增人员
      • 删除人员
      • 修改人员
      • 设置人员所属社区
      • 删除人员所属社区
      • 设置人员所属户室
      • 删除人员所属户室
      • 重置人员所属户室
      • 获取人员户室信息
      • 人员查询
      • 获取人员标签列表
      • 设置人员标签和车牌号
    • 物业人员管理
      • 新增物业人员
        POST
      • 修改物业人员
        POST
      • 删除物业人员
        DELETE
    • 卡片管理
      • 新增卡片(白卡)
      • 删除卡片(白卡)
      • 开卡
      • 退卡
      • 换卡
      • 挂失
      • 解挂
      • 补卡
    • 设备管理
      • 新增设备
      • 修改设备
      • 删除设备
      • 查询设备详情
      • 查询社区下的设备列表
      • 查询社区下设备通道列表
      • 设备抓图
    • 设备确权
      • 确权流程说明
      • 自动确权
      • 下线确认
      • 上线确认
    • 广告管理
      • 下发广告
      • 删除广告
    • 超脑人脸库列表
      • 超脑人脸库列表
      • 超脑人脸库添加人脸
      • 超脑人脸库删除人脸
      • 同步超脑人脸库
    • 门禁管理
      • 获取人员门禁设备信息
      • 人脸信息下发
      • 人脸信息删除
      • 远程控门
      • 动态密码
      • 我的二维码
      • 人员权限下发
      • 人员权限删除
      • 呼梯
      • 住户人员权限批量下发
    • 访客管理
      • 访客登记(预约)
      • 访客删除
    • 第三方跳转(旧)
      • 第三方跳转登录云眸普教对接规范
    • 第三方跳转
      • 第三方跳转登录云眸普教对接规范
    • 消息通道
      • 创建消费者
      • 消费消息
      • 提交偏移量
  • 移动端SDK
    • Android
    • IOS
    • 错误码对照表
  1. 物业人员管理

新增物业人员

POST
https://api2.hik-cloud.com/api/v1/estate/system/property
功能描述
新增物业人员信息。
备注:调用物业人员添加接口,就是在云眸平台注册了一个可以登陆的物业人员账号;返回的参数中appId和secret两个参数是在第三方跳转的时候需要用到的参数,具体用法详见:第三方跳转登录云眸社区对接规范。
返回码
返回码返回消息描述
510001参数错误必填项为空、参数长度不符合等参数异常情况
511015手机格式错误
511061有效社区id不能为空若 communityIds字段为“0”时报错,则是因为本租户未添加社区,请先调用添加社区接口,添加社区;若不为“0”时报错,则是因为根据所传id无法查到社区,请检查数据;若为空,则提示510001
511068角色信息不合法角色信息包含不符合约定的信息
511082用户名或手机号已被使用
511091用户名不合法用户名包含数字字母之外的非法字符
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api2.hik-cloud.com/api/v1/estate/system/property' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{

         
    "userName": "zhangsan",

         
    "phoneNumber": "15029936331",

         
    "communityIds": "00a795f4a25d4de09edd091f28747eb4,e09edd091f28747eb400a795f4a25d4d",

         
    "roleKeys": "COMMUNITY_ROLE_A,COMMUNITY_ROLE_B",

         
    "personName": "张三"

         
}'
响应示例响应示例
{
    "code": 200,
    "message": "操作成功",
    "data": {
        "personId": "00a795f4a25d4de09edd091f28747eb4",
        "appId": "8F91BEFC7CA5473E86353EC8269E1884",
        "secret": "5F9D6E2DCA8243709189D57B47A2DF22"
    }
}

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer {{access_token}}
Body 参数application/json
userName
string 
账号
可选
只支持数字和字母,建议不要填写,云眸后台支持自动填充
phoneNumber
string 
联系电话
必需
communityIds
string 
管辖社区
必需
多个社区id之间以逗号相隔;若传值为“0”,则默认管理所有小区
roleKeys
string 
角色
必需
多个角色之间以逗号相隔,角色列表见附录
personName
string 
姓名
必需
示例

返回响应

🟢200成功
application/json
Body
code
integer 
返回码
必需
message
string 
返回消息
必需
data
object 
节点对象
必需
personId
string 
人员id
必需
appId
string 
第三方登陆ID
必需
secret
string 
第三方登陆密钥
必需

【海康云眸】API开发者 微信交流群

用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

扫码加入交流群
上一页
设置人员标签和车牌号
下一页
修改物业人员
Built with