用户属性

大约 1 分钟

用户属性

用户属性指实时消息互动用户的资料,如用户昵称、头像、邮箱、电话、性别、签名、生日等。

环信 IM 提供用户资料的存储能力, 你可以根据自己的需要设置存储内容:

  • 默认资料字段的读写能力;
  • 自定义资料字段的读写能力。

用户属性字段

单个用户的所有属性最大不超过 2 KB,单个 app 所有用户属性数据最大不超过 10 GB。

关于用户属性,客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。调用 RESTful 接口设置删除用户属性时,若要确保在客户端能够获取设置,请求中必须传以下键名与客户端保持一致,键值可根据实际使用场景确定。

字段类型描述
nicknameString用户昵称。长度在 64 个字符内。
avatarurlString用户头像 URL 地址。长度在 256 个字符内。
phoneString用户联系方式。长度在 32 个字符内。
mailString用户邮箱。长度在 64 个字符内。
genderInt用户性别:
- 1:男;
- 2:女;
- (默认)0:未知;
- 设置为其他值无效。
signString用户签名。长度在 256 个字符内。
birthString用户生日。长度在 64 个字符内。
extString扩展字段。