外观
批量注册用户
约 271 字小于 1 分钟
2025-12-17
1. 描述
batchRegister() 方法用于向IM服务器批量注册用户,因注册属于异步操作,所以需要等待注册结果返回。 注意事项:
- 该方法会返回一个
Promise对象,用于后续逻辑处理; - 只有注册成功后才可以进行发送消息等操作,否则会导致后续操作失败;
- 如果注册过的用户重复注册,注册信息会
覆盖原来的信息; - 推荐在业务系统登录成功后,向IM服务器注册用户,避免重复注册;
- 单次批量注册用户最多 100 个;
- SDK版本 >= 1.3.6;
2. 参数
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| appKey | 是 | String | 应用Key,在开发者中心获取 |
| users | 是 | Array | 业务系统中的用户,包含的字段通单个注册一致 |
3. 返回值
返回Promise对象。
4. 示例代码
XBCIM.batchRegister({
appKey: 'your_app_key',
users: [
{userId: '', name: '', avatar: '', gender: '', email: '', phone: ''},
{userId: '', name: '', avatar: '', gender: '', email: '', phone: ''},
]
}).then(() => {
console.log('注册成功');
}).catch(error => {
console.error('注册失败', error);
});