Skip to content
v1
文档/Browser JS SDK/用户

@beeworks/imsdk


@beeworks/imsdk / user / IUserAttributes

IUserAttributes ​

用户属性接口

Properties ​

user_id ​

user_id: object

用户唯一标识,包含域和用户ID

domain_id ​

domain_id: string

域ID

id ​

id: string

用户ID


status ​

status: string

用户当前状态,如 "confirming"


source_id ​

source_id: string

来源系统ID,如 "workplus"


credentials ​

credentials: object

登录凭据信息

username ​

username: string

用户名

additional_credentials ​

additional_credentials: Record<string, unknown>

额外凭据的键值对


name? ​

optional name: string

姓名


pinyin? ​

optional pinyin: string

姓名拼音


initial? ​

optional initial: string

姓名首字母


nickname? ​

optional nickname: string

昵称


avatar? ​

optional avatar: string

头像URL


gender? ​

optional gender: ContactGender

性别,字符串表示,如 "male"/"female"


phone? ​

optional phone: string

手机号码


email? ​

optional email: string

邮箱地址


initial_password ​

initial_password: boolean

是否为初始密码


user_agreement_singed ​

user_agreement_singed: boolean

用户协议是否已签署


conflict ​

conflict: boolean

是否存在账号冲突


disabled ​

disabled: boolean

账号是否被禁用


deleted ​

deleted: boolean

账号是否被删除


create_time ​

create_time: number

创建时间戳(毫秒)


modify_time ​

modify_time: number

修改时间戳(毫秒)


face_id_agreement_singed ​

face_id_agreement_singed: boolean

人脸协议是否已签署


user_face_id ​

user_face_id: object

人脸ID信息

provider ​

provider: string

人脸识别提供方

id ​

id: string

人脸ID

disabled ​

disabled: boolean

人脸功能是否禁用

metadata ​

metadata: Record<string, unknown>

额外元数据


tags ​

tags: unknown[]

标签列表


tag_snapshots ​

tag_snapshots: unknown[]

标签快照列表


query_name? ​

optional query_name: string

用于查询展示的名称


phone_nation? ​

optional phone_nation: string

手机国家码


phone_bound? ​

optional phone_bound: boolean

是否绑定手机号


email_bound? ​

optional email_bound: boolean

是否绑定邮箱