建立连接

初始化客户端实例（幂等），使用服务端签发的 Token 建立与 IM 服务的长连接，并处理断线重连与连接状态回调。

平台调用风格

异步风格：Promise<RcResult<T>>（{ code, data?, msg? }）；业务错误通过 res.code !== 0 判断，不抛异常。

接口一览​

操作语义传输返回
init初始化 SDK（构造客户端实例）。幂等：同 appkey 重复初始化返回同一实例。本地IMClient
connect使用用户 token 建立长连接：握手→hello→离线补发→sync_done；成功后触发 CONNECTED。失败按协议重连策略重试。WS 长连接{userId:string, sessionId?:string}
disconnect主动断开；停止重连、清理心跳与待决请求。WS 长连接null
getConnectionStatus返回 ConnectionStatus 枚举值。本地ConnectionStatus

本页 4 个操作，其中 4 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
initIMClient.initconstructorinitinitRCIMIWEngine.createim_client_newstatic
connectconnectconnectconnectconnectconnectim_client_connectfunc
disconnectdisconnectdisconnectdisconnectdisconnectdisconnectim_client_disconnectfunc
getConnectionStatusgetConnectionStatusgetConnectionStatusgetConnectionStatusgetConnectionStatusgetConnectionStatusim_client_connection_statusfunc

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

init​

初始化 SDK（构造客户端实例）。幂等：同 appkey 重复初始化返回同一实例。

constructor(options) / init(options)
本地幂等since 1.0.0
参数
参数类型说明
options{appkey:string, serverUrl?:string, timeoutMs?:uint32, transport?:any}必填；选项对象（字段见类型列）：{ appkey:string, serverUrl?:string, timeoutMs?:uint32, transport?:any }
返回

IMClient 客户端实例（幂等：同 appkey 重复初始化返回同一实例）

示例
JavaScript
import { createClient } from '@ni-paas/im-web';

const client = createClient({
  appkey: 'YOUR_APP_KEY',
  serverUrl: 'https://im.example.com',
});
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误

connect​

使用用户 token 建立长连接：握手→hello→离线补发→sync_done；成功后触发 CONNECTED。失败按协议重连策略重试。

connect(token)
WS 长连接since 1.0.0
参数
参数类型说明
tokenstring必填；用户 Token（由业务服务签发，禁止在客户端硬编码 AppSecret）
返回

{userId:string, sessionId?:string} 登录用户 ID 与会话 ID

示例
JavaScript
const res = await client.connect('TOKEN');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;
错误码
错误码名称分类HTTP可重试说明
1002INVALID_TOKEN客户端 / 参数 / 权限401否Token 无效或已过期
1016USER_BANNED客户端 / 参数 / 权限403否账号已被封禁
1017APP_DISABLED客户端 / 参数 / 权限403否应用已停用
2001INTERNAL_ERROR服务端 / 依赖500是服务端内部错误
2002DEPENDENCY_UNAVAILABLE服务端 / 依赖503是依赖服务不可用
3002SDK_TIMEOUTSDK 本地0是请求超时
3003SDK_NETWORK_ERRORSDK 本地0是网络错误

disconnect​

主动断开；停止重连、清理心跳与待决请求。

disconnect()
WS 长连接幂等since 1.0.0
返回

null 无返回数据；成功与否通过错误码判断

示例
JavaScript
await client.disconnect(); /* code === 0 为成功 */

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

getConnectionStatus​

返回 ConnectionStatus 枚举值。

getConnectionStatus()
本地since 1.0.0
返回

ConnectionStatus 连接状态枚举：CONNECTED / CONNECTING / DISCONNECTED / SUSPEND

示例
JavaScript
const status = client.getConnectionStatus();

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

相关文档​