1. 用户API

API列表

编号 API名称 路径 版本
1.1 登录 /mid/user/auth 1.0
1.2 发送验证码 /mid/user/sms/send 1.0
1.3 获取随机码 /mid/user/random/get 1.0
1.4 注册 /mid/user/register 1.0
1.5 修改密码 /mid/user/password/modify 1.0
1.6 忘记密码 /mid/user/password/forgot 1.0
1.7 查询个人信息 /mid/user/profile 1.0
1.8 修改个人信息 /mid/user/modify 1.0
1.9 集团员工认证 cas/mip/auth 1.0
1.10 头像上传 /mid/user/profile/photo/upload 1.0
1.11 修改个人偏好 user/preference/save 1.0
1.12 获取个人偏好 user/preference/fetch 1.0
1.13 删除个人偏好 user/preference/delete 1.0
1.14 校验短信验证码 /mid/user/sms/validate 1.0
1.15 获取公众号openid /mid/user/wechat/get/openid 1.0
1.16 切换小区 /user/switch/community 1.0
1.17 获取公众号jsApiTicket /user/wechat/get/ticket 1.0
1.18 邀请非app用户加入家庭 /mid/user/new/join/family/invite 1.0
1.19 根据手机号搜素用户 /mid/user/mobile/query 1.0
1.20 用户注销 /mid/user/cancellAccout 1.0
1.21 客服回复 biz/mob/eval/suggest/replySuggestion 1.0

API调用

1.1: 登录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/auth

方法：POST

请求参数

名称 位置 类型 必填 描述
loginId BODY STRING 是 登录账号
password BODY STRING 否 登录密码（使用RSA非对称加密(随机码+用户密码）
verifyCode BODY STRING 否 登录短信验证码（当用户密码为空是必填的）

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

{
  "loginId": "13800138000",
  "password": "xxxxxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
userId 顶层 STRING 是 用户Id
nickname data STRING 是 用户昵称
mobile data STRING 是 手机号码
gender data STRING 是 性别(F/M)
account data STRING 否 用户自定义账号
profilePhoto data STRING 否 用户头像
userDesc data STRING 否 用户个性签名
accessToken data STRING 是 访问令牌
expires data STRING 是 有效时间(秒)
refreshToken data STRING 是 刷新令牌

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
     "nickname":"xxxx",
     "mobile":"138xxxxxx",
     "gender":"F",
     "account":"xxx"
  }
}

异常返回示例

{"code":"401","message":"账户或密码错误"}

错误码

错误码 错误信息 描述
401 Invalid Signature 签名无效
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.2:发送验证码

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/sms/send

方法：POST

请求参数

名称 位置 类型 必填 描述
mobile BODY STRING 是 手机号码
funcType BODY STRING 否 验证码类型(0=用户登录, 1=用户注册, 2=忘记密码)

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

{
  "mobile": "13800138000",
  "funcType": "0"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {}
}

异常返回示例

{"code":401,"message":"The mobile is registered"}

错误码

错误码 错误信息 描述
401 The mobile is registered 手机已注册
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.3:获取用户随机码

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/random/get

方法：POST

请求参数

名称 位置 类型 必填 描述
identityType BODY STRING 是 证件类型（0=手机号码，1=邮箱，2=用户账户）
identity BODY STRING 是 证件号码
funcType BODY STRING 是 随机码类型(0=登录，1=注册，2修改密码)

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

{
  "identityType": "0",
  "identity": "13800xxxxx",
  "funcType": "0"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
randomCode data STRING 是 随机码
pubKey data STRING 是 公钥

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "randomCode": "123456",
      "pubKey":"xxxxxxxxx"
  }
}

异常返回示例

{"code":401,"message":"The mobile is registered"}

错误码

错误码 错误信息 描述
401 The mobile is registered 手机已注册
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.4:用户注册

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/register

方法：POST

请求参数

名称 位置 类型 必填 描述
mobile BODY STRING 是 手机号码
password BODY STRING 是 用户密码（使用RSA非对称加密(随机码+用户密码）)
verifyCode BODY STRING 是 短信验证码

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

{
  "mobile": "13800138000",
  "password": "xxxx",
  "verifyCode": "1234"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

异常返回示例

{"code":401,"message":"The mobile is registered"}

错误码

错误码 错误信息 描述
401 The mobile is registered 手机已注册
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.5:修改密码

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/password/modify

方法：POST

请求参数

名称 位置 类型 必填 描述
password BODY STRING 是 用户原密码（使用RSA非对称加密(随机码+用户密码）
newPassword BODY STRING 是 用户新密码（使用RSA非对称加密(随机码+用户密码）

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

{
  "password": "xxxx",
  "newPassword":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

异常返回示例

{"code":401,"message":"The mobile is registered"}

错误码

错误码 错误信息 描述
401 The mobile is registered 手机已注册
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.6:忘记密码

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/password/forgot

方法：POST

请求参数

名称 位置 类型 必填 描述
mobile BODY STRING 是 手机号码
password BODY STRING 是 用户新密码（使用RSA非对称加密(随机码+用户密码）
verifyCode BODY STRING 是 短信验证码

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

{
  "mobile": "13800138000",
  "password": "xxx",
  "verifyCode": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {}
}

异常返回示例

{"code":402,"message":"The mobile is not registered"}

错误码

错误码 错误信息 描述
402 The mobile is not registered 手机未注册
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

1.7:获取个人信息

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/profile

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 否 用户Id

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

{
  "userId": "10001"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
userId data STRING 是 用户Id
nickname data STRING 是 用户昵称
mobile data STRING 是 手机号码
gender data STRING 是 性别(F/M)
account data STRING 否 用户自定义账号
profilePhoto data STRING 否 用户头像
userDesc data STRING 否 用户个性签名

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {}
}

异常返回示例

{"code":402,"message":"The user is not exist"}

1.8:修改个人信息

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/modify

方法：POST

请求参数

名称 位置 类型 必填 描述
nickname BODY STRING 否 用户昵称
userDesc BODY STRING 否 用户个性签名
profilePhoto BODY STRING 否 用户头像

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

{
  "userId": "10001",
  "nickname": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {}
}

异常返回示例

{"code":402,"message":"The account is not exist"}

1.9:集团员工认证

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：cas/mip/auth

方法：POST

请求参数

名称 位置 类型 必填 描述
userId BODY STRING 是 集团用户账号
password BODY STRING 是 用户密码（使用RSA非对称加密(随机码+用户密码）

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

{
  "userId": "xxx",
  "password": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {}
}

异常返回示例

{"code":"402","message":"The account is not exist"}

1.10:头像上传

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/profile/photo/upload

方法：POST

请求参数

名称 位置 类型 必填 描述
file BODY STRING 是 图片Base64字符串（不需要data:image/jpeg;base64,标记）

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

{
  "file": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
picUrl data STRING 是 图片地址

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "picUrl": "xxxxx"
  }
}

异常返回示例

{"code":"402","message":"The account is not exist"}

1.11:修改偏好设置

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/preference/save

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
scenePref BODY ARRAY 否 场景设置
roomPrefs BODY ARRAY 否 房屋设置
devicePrefSorts BODY JSON 是 偏好内容

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

{
  "userId": "2344",
  "houses": [
    {
    "houseId": "2343",
      "scenePref": [{
        "sceneId": 41298,
        "icon": "xx",
        "seqNo": "1"
      }],
      "roomPrefs": [{
        "seqNo": "1",
        "roomId": 40833
      }],
      "devicePrefSorts":  [{
        "devId": "1099511811877",
        "seqNo": "41424_10",
        "seqNoFavor": "4",
        "isFavor": "1"
      }]
    }
  ],
  "famillys": [{
    "famillyId": "32323",
    // 扩展字段
  }],
  "communitys": [{
    "communityId": "32323",
    // 扩展字段
  }],
  // 扩展字段
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

异常返回示例

{"code":"402","message":"The account is not exist"}

1.12:获取偏好设置

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：user/preference/fetch

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
keys BODY STRING 否 需要返回的属性名称（逗号隔开）

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

{
  "keys": "houses,famillys"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
[anything] data OBJECT 是 偏好内容
keys data STRING 是 已存字段

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
    {
       "keys": "houses,famillys",
       "houses": [
        {
        "houseId": "2343",
         "scenePref": [{
          "sceneId": 41298,
          "icon": "xx",
          "seqNo": "1"
         }],
         "roomPrefs": [{
          "seqNo": "1",
          "roomId": 40833
         }],
         "devicePrefSorts":  [{
          "devId": "1099511811877",
          "seqNo": "41424_10",
          "seqNoFavor": "4",
          "isFavor": "1"
         }]
        }
       ],
       "famillys": [{
        "famillyId": "32323",
        // 扩展字段
       }],
       "communitys": [{
        "communityId": "32323",
        // 扩展字段
       }],
       // 扩展字段
      }
  }
}

异常返回示例

{"code":"402","message":"The account is not exist"}

1.13:删除偏好设置

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：user/preference/delete

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

异常返回示例

{"code":"402","message":"The account is not exist"}

1.14:校验短信验证码

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/sms/validate

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
mobile body string 是 手机号码
funcType body string 是 验证码类型(0=用户登录, 1=用户注册, 2=忘记密码)
verifyCode body string 是 短信验证码

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

{
  "mobile": "138xxxxx",
  "funcType": "0",
  "verifyCode": "123456"
}

1.15:切换小区接口

描述

切换小区

请求信息

HTTP协议：HTTP,HTTPS

uri：user/switch/community

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
mobile body string 是 手机号码
funcType body string 是 验证码类型(0=用户登录, 1=用户注册, 2=忘记密码)
verifyCode body string 是 短信验证码

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

{
  "communityId": "12333123",
  "msgId": "11111"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success"
}

1.15: 获取公众号openid

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/wechat/get/openid

方法：POST

请求参数

名称 位置 类型 必填 描述
code BODY STRING 是

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

{
  "code": "061RerfT0YyYUZ1yQedT0BOdfT0RerfG"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
openid data STRING 是

返回结果示例

{
    "code": 200,
    "data": {
        "openid": "oi_9j04fPT9N-66ll-ZbwYMA4o00"
    },
    "message": "success"
}

异常返回示例

{"code":"11006","message":"用户不存在"}

1.16:切换小区接口

描述

切换小区

请求信息

HTTP协议：HTTP,HTTPS

uri：user/switch/community

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
communityId body string 是 小区标识
msgId body string 是 消息标识

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

{
  "communityId": "12333123",
  "msgId": "11111"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success"
}

异常返回示例

{"code":"11006","message":"用户不存在"}

1.17:获取公众号jsApiTicket

描述

获取公众号jsApiTicket

请求信息

HTTP协议：HTTP,HTTPS

uri：user/get/ticket

方法：POST

请求HEADER

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述

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

{
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
ticket data STRING 是 jsApiTicket

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "ticket": "HoagFKDcsGMVCIY2vOjf9l5hku92ZMXjEH-WfcQApFI6jmfL6FIj5JmkyoNb3BrpHRoMJxyL0hmB8hzqCDAJVg"
  }
}

异常返回示例

{"code":"11006","message":"用户不存在"}

1.18:邀请非app用户加入家庭

描述

邀请非app用户加入家庭

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/new/join/family/invite

方法：POST

请求HEADER

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
inviteePhone BODY LONG 是 被邀请用户手机号
houseId BODY Long 是 房屋ID
familyId BODY LONG 是 家庭ID
roleTag BODY STRING 是 家庭角色(3-业主成员 14-租户 15-租户成员)

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

{
    "inviteePhone": "",
    "houseId": "",
    "familyId": "",
    "roleTag": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
ticket data STRING 是 jsApiTicket

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
  }
}

异常返回示例

{"code":"11006","message":"用户不存在"}

1.19:根据手机号搜素用户

描述

根据手机号搜素用户

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/mobile/query

方法：POST

请求HEADER

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
mobile BODY LONG 是 用户手机号
pageNo BODY LONG 是 页数
pageSize BODY STRING 是 每页条数

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

{
    "mobile": "180*******",
    "pageNo": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
ticket data STRING 是 jsApiTicket

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
  }
}

异常返回示例

{"code":"11006","message":"用户不存在"}

1.20:用户注销

描述

获取

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/user/cancellAccout?appId=1000

方法：POST

请求HEADER

名称 位置 类型 必填 描述
userId header String 是 用户ID

请求参数

名称 位置 类型 必填 描述
verifyCode body string 是 短信验证码

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

{

  "verifyCode": "123456"
}

返回结果示例

{
  "code": "200",
  "message": "success"
}


## 1.20:<span id="120">用户注销</span>


###  描述 

获取

###  请求信息 

HTTP协议：HTTP,HTTPS

uri：/mid/user/cancellAccout?appId=1000

方法：POST

###  请求HEADER

|  名称  |  位置  |  类型  | 必填 |  描述  |
|--------|--------|--------|------|--------|
| userId | header | String | 是   | 用户ID |

###  请求参数 

| 名称       | 位置 | 类型   | 必填 | 描述                                           |
| ---------- | ---- | ------ | ---- | ---------------------------------------------- |
| verifyCode | body | string | 是   | 短信验证码                                     |


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

{

"verifyCode": "123456" }


#### 返回结果示例

{ "code": "200", "message": "success" }

1.21:客服回复

描述

保存客服回复

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/mob/eval/suggest/replySuggestion

方法：POST

请求HEADER

名称 位置 类型 必填 描述
tokeninfo header String 是 用户信息
access-token header String 是 接口token

请求参数

名称 位置 类型 必填 描述
suggestId body Integer 是 问题反馈ID
replyContent body String 是 客服回复内容

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

{

  "suggestId": "1",
  "replyContent":"haha"
}

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "保存成功"
}

错误码列表(11001-11999)

错误码 错误信息 描述
11001 手机号码未注册 手机号码未注册
11002 用户账号或密码错误 用户账号或密码错误
11003 手机验证码错误 手机验证码错误
11004 参数错误 参数错误
11005 注册失败 注册失败
11006 the user not exists 用户不存在
11801 访问四格登录错误 访问四格登录错误
11802 访问四格WEB接口错误 访问四格WEB接口错误
11803 调用四格主数据接口异常 主数据api接口异常
11901 阿里云短信服务异常 阿里云短信服务异常
11902 4A系统服务异常 4A系统服务异常
11903 C4A系统服务异常 C4A系统服务异常
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""