根据用户ID获取用户的概要信息

优质
小牛编辑
129浏览
2023-12-01

接口说明

根据用户ID获取用户的概要信息
如需调用,请访问 开发者文档 来查看详细的接口使用说明
该接口仅开放给已获取SDK的开发者

API地址

GET /usercenter/api/userinfo/v1.0.0/getUserGeneralByUid

是否需要登录

请求字段说明

参数类型请求类型是否必须说明
userIdstringquery用户ID

响应字段说明

参数类型说明
loginNamestring登录账号名
nickNamestring昵称
realNamestring真实姓名
userTypestring用户类型(1:个人用户,2企业用户)
certificatStatusstring实名认证状态(0:未认证,1:已实名认证,2:认证失败,3:待审核)

响应成功示例

{
  "code": 0,
  "data": {
    "realName": "",
    "orgName": "",
    "nickName": "",
    "certificatStatus": "0",
    "loginName": "test01",
    "photo": null,
    "userType": "1"
  },
  "message": "成功"
}

响应失败示例

{
  "code": 500,
  "message": "未知错误,请及时联系管理人员进行处理"
}

响应接受类型

application/json

响应状态码

HTTP状态码原因
0成功
200OK
401Unauthorized
403Forbidden
404Not Found
10000token不能为空
10001token已失效,请重新登录
12013用户信息不存在
12029用户ID不能为空
99998非法请求
99999服务器异常

示例代码

$.ajax({

    url: '/usercenter/api/userinfo/v1.0.0/getUserGeneralByUid?userId=',

    type: 'GET',

    data: '',

    dataType: 'text',

    cache: false,

    contentType: 'application/json',

    xhrFields: {

        withCredentials: true

    },

    crossDomain: true,

    success:function(data){

        // 成功返回值

    },

    error:function(XMLHttpRequest, textStatus, errorThrown){

    

    }

})