getUserInfo

获取已登录用户的基本信息或特殊信息。

注意事项：

小程序调用前，请确保已经调用login接口成功登录；

支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.6.0	3.6.0	3.8.0	扫码预览 用BoosHi扫码或PC端点击
网页应用	3.19.0	3.19.0	3.19.0	-

输入

继承标准对象输入，扩展属性描述：

名称	数据类型	必填	默认值	描述
withCredentials	boolean	否	false	是否需要返回敏感数据 网页应用不支持

输出

success返回对象的扩展属性：

名称	数据类型	描述
userInfo	object	用户信息
∟ nickName	string	用户昵称
∟ avatarUrl	string	用户头像
∟ gender	string	用户性别 可选值： ''：未知 male：男性 female：女性
∟ country	string	用户所在国家或地区
∟ province	string	用户所在省份 该字段已下线
∟ city	string	用户所在城市
∟ language	string	所在地区所用的语言 可选值： en_US：英文 zh_CN：中文
rawData	string	userInfo的JSON字符串形式
signature	string	用于校验用户信息是否被篡改（withCredentials需为true）
encryptedData	string	包括敏感信息（如openId, unionId, email, employee_id, watermark等）在内的已加密用户数据（withCredentials需为true）
iv	string	加密算法参数（withCredentials需为true）

示例代码

bz.getUserInfo({
    withCredentials: true,
    success(res) {
      console.log(JSON.stringify(res));
    },
    fail(res) {
      console.log(`getUserInfo fail: ${JSON.stringify(res)}`);
    }
});

success返回对象示例：

{
    "userInfo": {
        "avatarUrl": "https://s1-imfile.feishucdn.com/static-resource/v1/c8a42593-e88f-4fdb-8c70-631xxxxxx~?image_size=72x72&cut_type=&quality=&format=png&sticker_format=.webp",
        "city": "武汉",
        "country": "CN",
        "gender": "male",
        "language": "",
        "nickName": "张三",
        "province": ""
    },
    "signature": "383292bbece2bc4d0b7591xxxxxxxxxx",
    "encryptedData": "sJbpFAqEo1xjI+gzhQDLqXxxxxxxxxx",
    "rawData": "{\"nickName\":\"张三\",\"avatarUrl\":\"https://s1-imfile.feishucdn.com/static-resource/v1/c8a42593-e88f-4fdb-8c70-631xxxxxx~?image_size=72x72\\u0026cut_type=\\u0026quality=\\u0026format=png\\u0026sticker_format=.webp\",\"gender\":\"male\",\"city\":\"武汉\",\"province\":\"\",\"country\":\"CN\",\"language\":\"\",\"i18nName\":{\"en_us\":\"Zhang San\",\"ja_jp\":\"\",\"zh_cn\":\"\"}}",
    "iv": "bd49a34ccf1e415da113bxxxxxxx",
    "errMsg": "getUserInfo:ok"
}