1. IM通讯API

API列表

编号 API名称 路径 版本
1.1 通讯认证 /imc/authorize 1.0
1.2 账号创建 /imc/account/create 1.0
1.3 创建部门 /imc/dept/create 1.0
1.5 用户拉取管家列表（查询数据库） /imc/queryStaffByCommunityId 1.0
1.7 获取员工拥有项目列表接口（查询四格） /imc/getAuthCommunityList 1.0
1.71 获取员工拥有项目列表接口（查询四格）（新） /imc/getAuthCommunityListV5 1.0
1.8 管家拉取负责小区客户列表（查询数据库） /imc/queryWorkCommunityCusters 1.0
1.9 上传管家头像 /imc/uploadWorkerIco 1.0
1.10 业主通讯录 /imc/addressBook/get 1.0
1.11 员工切换项目接口 /imc/switchCommunity 1.0
1.12 员工获取默认项目接口 /imc/myDefaultCommunity 1.0
1.13 获取业主注册状态 /imc/checkRegisterStatus 1.0
1.14 获取业主对应管家的管家昵称 /imc/user/butler/get 1.0

API调用

1.1: 通讯认证

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/authorize

方法：POST

请求参数

名称 位置 类型 必填 描述
account BODY STRING 是 登录ID：userId/员工号
password BODY STRING 是 登录密钥：token

请求Body描述(非Form表单数据)

{
  "account": "123456",
  "password": "23432sddsfs",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}
异常返回示例
{"code":"1301","message":""}

1.2: 业主账号创建

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/account/create

方法：POST

请求参数

名称 位置 类型 必填 描述
msgId BODY STRING 否 随便传，后台没校验
customerId BODY STRING 否 传了就创建这个用户，等于云朵的userId,用于管家端创建用户

请求Body描述(非Form表单数据)

{
  "msgId":"123"
  "customerId":"123"
}

返回信息

返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.3: 部门创建

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/dept/create

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
    "sourceId": "982c39a7",
    "depts": [{
            "departmentNumber": "101000",
            "displayName": "VPS",
            "parentId": ""
        },
        {
            "departmentNumber": "101001",
            "displayName": "美的物业员工",
            "parentId": "101000"
        },
        {
            "departmentNumber": "101002",
            "displayName": "美的物业业主",
            "parentId": "101000"
        }
    ]
}

返回信息

返回参数类型

JSON

返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 用户拉取管家列表（查询数据库）

描述 查询数据库

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/queryStaffByCommunityId

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
    "communityId":1865367   //非必传，不传就发送所有小区的管家信息
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": [
        {
            "AREA_ID": 1212010,
            "butlerName": "冬青",
            "realName": "卢少扬",
            "picUrl": "https://mns-sit.smartmideazy.com/file/v5/app/download/561378/public/muc/photo/3369582741485568?1567583698582",
            "community_id": 1003837,
            "name": "翰诚嘉园所有商铺",
            "tel": "",
            "job_number": "lusy6",
            "userId": 1865367
        },
        {
            "AREA_ID": 1212010,
            "butlerName": "冬青",
            "realName": "梁嘉咏",
            "picUrl": "https://mns-sit.smartmideazy.com/file/v5/app/download/561378/public/muc/photo/3369582741485568?1567583698582",
            "community_id": 1003837,
            "name": "翰诚嘉园所有商铺",
            "tel": "",
            "job_number": "liangjy1",
            "userId": 12888
        }
    ],
    "message": "success"
}

1.7: 获取员工拥有项目列表接口（查询四格）

描述 查询四格，不能以小区区分

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/getAuthCommunityList

方法：POST

请求参数

名称 位置 类型 必填 描述
ticket ---- ------ 是 员工登录的token里面携带的ticket字段-

请求Body描述(非Form表单数据)

{
    "ticket":"64bc062c-42d8-4751-950d-d1c976697fc0"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": [
        {
            "name": "美的广夏花园",
            "organId": 21322160,
            "communityId": 21322160
        }
    ],
    "message": "success"
}

1.71: 获取员工拥有项目列表接口（查询四格）（新）

描述 查询四格，不能以小区区分

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/getAuthCommunityListV5

方法：POST

请求参数

名称 位置 类型 必填 描述
ticket ---- ------ 是 员工登录的token里面携带的ticket字段-

请求Body描述(非Form表单数据)

{
    "ticket":"64bc062c-42d8-4751-950d-d1c976697fc0"
}

返回信息

返回参数类型

JSON

返回结果示例
{
"code" :"",     //错误码,code= 0 正确,code= -1 错误
"msg" :"",       //错误信息 
 "data": [
    {
      "communityId": 67,
      "communityName": "测试",
      "organId": 671024,
      "organName": "测试",
      "pySname": null,
      "pyStart": null
    },...]
}

1.8: 管家拉取负责小区客户列表（查询四格）

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/queryWorkCommunityCusters

方法：POST

请求参数

名称 位置 类型 必填 描述
uid ---- ------ 是 员工的账号

请求Body描述(非Form表单数据)

{
    "uid":maisq1
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": [
        {
            "name": "毛艳红",
            "tel": "15019679970",
            "resource_name": "5栋_/_201"
            "registerStatus": 1     //0代表未有云朵账号， 1代表已注册云朵但未有im账号 2代表有im的登录账号
            "userId":123    //用户在云朵的唯一userId
        },
        {
            "name": "李娟",
            "tel": "13450569097",
            "resource_name": "5栋_/_305"
            "registerStatus": 0
        }
    "message": "success"
}

1.9: 上传管家头像

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/uploadWorkerIco

方法：POST

请求参数

名称 位置 类型 必填 描述
url ---- ------ 是 要上传的头像
userId ---- ------ 是 获取管家信息中的 userId

请求Body描述(非Form表单数据)

{
    "url":"https://mns-sit.smartmideazy.com/file/v5/app/download/561378/public/muc/photo/3369582741485568?1567583698582",
    "userId":12888
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data":""
    "message": "success"
}

1.10: 业主通讯录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/addressBook/get

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId BODY LONG 是 小区ID
userName BODY STRING 否 管家登录账号（获取管理区域时必填）
areaId BODY LONG 否 区域ID（当获取管理楼栋时必填）
buildId BODY LONG 否 楼栋ID（获取楼栋单元时必填）
unitId BODY LONG 否 单元ID（获取房屋时必填）
houseId BODY LONG 否 房屋Id（获取房屋业主时必填）

请求Body描述(非Form表单数据)

// 获取管理区域
{
    "communityId": 21322147,
    "userName": "maisq1"
}
// 获取区域楼栋
{
    "areaId": 1202018
}
// 获取区域楼栋单元
{
    "areaId": 1202018,
    "buildId": 50171077 
}
// 获取区域房屋
{
    "areaId": 1202018,
    "buildId": 50171077,
    "unitId":50171078
}
// 获取区域房屋业主
{
    "houseId":35228187
}

返回信息

返回参数类型

JSON

返回结果示例
//返回管理区域
{
    "code": 200
    "message": "success",
    "data":{
        "list":[{
             "areaId": 1202018,
              "displayName": "广夏5-8栋"
        }]
    }   
}
//返回管理区域楼栋
{
    "code": 200
    "message": "success",
    "data":{
        "list":[
             {
                "displayName": "5栋",
                "buildId": 50171077
            }
        ]
    }   
}
//返回管理区域楼栋单元
{
    "code": 200
    "message": "success",
    "data":{
        "list":[{
             "displayName": "/",
             "unitId": 50171078,
             "buildId": 50171077
        }]
    }   
}
//返回管理区域楼栋单元房屋
{
    "code": 200
    "message": "success",
    "data":{
        "list":[{
            "houseName": "5栋_/_102",
            "houseId": 35228187,
            "displayName": "102"
        }]
    }   
}
//返回管理区域楼栋单元房屋业主
{
    "code": 200
    "message": "success",
    "data":{
        "list":[{
            "custName": "美的集团股份有限公司",
            "custPhone": "18688210829",
            "custStatus": 0, //0代表未有云朵账号， 1代表已注册云朵但未有im账号 2代表有im的登录账号
            "userId": 121
        }]
    }   
}

1.11: 员工切换项目接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/switchCommunity

方法：POST

请求参数

名称 位置 类型 必填 描述
ticket ---- ------ 是 ticket
communityId ---- ------ 是 communityId

请求Body描述(非Form表单数据)

{
"ticket": "6229a885-9290-414a-8361-5ece44a9faa0",
"communityId":21291184
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": {
        "organId": 21331125,
        "communityName": "美的智慧生活体验馆02",
        "communityId": 21322229
    },
    "message": "success"
}

1.12: 员工获取默认项目接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/myDefaultCommunity

方法：POST

请求参数

名称 位置 类型 必填 描述
ticket ---- ------ 是 ticket

请求Body描述(非Form表单数据)

{
"ticket": "6229a885-9290-414a-8361-5ece44a9faa0"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": {
        "organId": 21331125,
        "communityName": "美的智慧生活体验馆02",
        "communityId": 21322229
    },
    "message": "success"
}

1.13: 获取业主注册状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/checkRegisterStatus

方法：POST

请求参数

名称 位置 类型 必填 描述
userId ---- ------ 是 云朵社区的userId

请求Body描述(非Form表单数据)

{
    "userId": "227"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": {
        "registerStatus": 1
    },
    "message": "success"
}

1.14: 获取业主对应管家的管家昵称

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/imc/user/butler/get

方法：POST

请求参数

名称 位置 类型 必填 描述
jobNumber BODY STRING 是 管家账号
userId BODY LONG 是 云朵社区的userId
communityId BODY LONG 是 云朵社区的小区Id

请求Body描述(非Form表单数据)

{
    "jobNumber": "hewx6",
    "userId": 12594,
    "communityId":"21441118"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "data": {
        "butlers": [
            {
                "butlerName": "CZX",
                "areaId": 1292008,
                "areaName": "1D-区域",
                "name": "何伟贤",
                "butlerTel": "18978346824"
            }
        ]
    },
    "message": "success"
}

错误码列表(61001-61999)

错误码 错误信息 描述
61001 login failure 登录失败
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""