客户端登录互动消息服务

客户端SDK

您可以通过以下两种方式使用互动消息服务客户端SDK。

方式一：独立SDK

互动消息提供独立客户端SDK，支持包括Android、iOS、H5和微信小程序。

方式二：集成AUI

如果您已经集成了视频直播AUI，可以使用AUI提供的接口，调用互动消息服务。

SDK初始化

以Android端SDK初始化为例。

在App入口（如Application/Activity的onCreate中）进行初始化配置。

 ImSdkConfig config = new ImSdkConfig();
 config.deviceId = "deviceId"; //[选填]
 config.appId = "appId"; //[必填]
 config.appSign = "appSign"; //[必填]
	
 int ret = AliVCIMEngine.instance().init(context, config);

SDK登录

以Android登录为例。

ImLoginReq req = new ImLoginReq();

req.user.userId = userId;
//透传业务额外信息
Map<String, Object> data = new HashMap<>();
data.put("level", "high");
req.user.userExtension = App.getGson().toJson(data).toString();

req.userAuth = new ImAuth(nonce,  timestamp, role, app_token);
AliVCIMEngine.instance().login(req, new ImSdkCallback());

app_token参数的生成方式：

app_token = sha256(appId + appKey  + userId + nonce + timestamp + role)

监听连接状态

以Android SDK为例。

AliVCIMEngine.instance().addSdkListener(new ImSdkListener() {
    @Override
    public void onConnecting() {
        
    }
    @Override
    public void onConnectSuccess() {
    }
    @Override
    public void onConnectFailed(com.aliyun.im.common.Error error) {
    }
    @Override
    public void onDisconnect(int code) {
    }
    // 登录token失效（如token过期）会通过该接口获取新的token，务必实现该接口
    @Override
    public void onTokenExpired(ImTokenCallback callback) {
        // 第一步，实现新token的生成，若需要网络请求等耗时操作，请务必抛到异步线程实现；
        // 第二步，若token生成失败，则通过 callback.onError() 回调错误信息；
        // 		若token生成成功，则通过 callback.onSuccess() 回调token信息；
    }
    @Override
    public void onReconnectSuccess(ArrayList<ImGroupInfo> groupStatus) {
    }
});

最佳实践

1. 业务服务器给客户端的返回包括以下内容。

   {
       "auth": {
           "nonce": "产生token所用的nonce",
           "timestamp": 131231234, //<传产生token所传递的timestamp值,数值类型>
           "role": "产生token所传递的role",
           "user_id": "产生token所用的userid"
       },
       "app_id": "{您的应用AppID}", 
       "app_sign": "{您的应用AppSign}",
       "app_token": "{生成的token}"
   }

2. SDK使用步骤1传回参数初始化.

3. SDK使用步骤1传回参数登录。

4. SDK检查登录回调。

   • 登录成功，则继续后面的流程。

   • 登录失败回调，打印排查。

5. 在Token过期回调中（onTokenExpired），实现异步从您的业务服务器（图中的AppServer）更新timestamp，以获取新的Token以及其他对应参数，设置给SDK。

常见问题

echo -n "{appId}{appKey}{userId}{nonce}{timestamp}{role}" | openssl dgst -sha256
// 注：用实际的内容填充时，记得去掉大括号。