1. 描述

getUserList() 方法用于获取注册到IM服务的用户列表，是一个异步方法，返回值为Promise对象。

2. 参数

参数名称	是否必选	类型	说明
keywords	否	String	关键词，用于模糊搜索用户昵称或用户名
page	否	Number	页码，用于分页获取用户列表，默认为1
pageSize	否	Number	每页数量，用于分页获取用户列表，默认为20

3. 返回值

返回值为Promise对象，resolve值为用户列表数组（数组元素结构如下），reject值为错误信息。

字段	类型	说明
userId	String	用户ID
name	String	用户昵称
avatar	String	用户头像
phone	String	加密后的手机号
email	String	加密后的邮箱
gender	String	用户性别，unknown：未知，male：男，female：女
updateTime	String	修改时间
createTime	String	创建时间

4. 示例代码

XBCIM.getUserList({
  keywords: '张三',
  page: 1,
  pageSize: 20
}).then(list => {
  console.log(list);
}).catch(error => {
  console.error(error);
});