使用 SDK 进行呼叫之前,您需要首先进行注册或登录。在云视讯平台每个用户有唯一的账号标识。SDK 提供三方账号登录以及小鱼系统账号登录两种登录方式。
如果您的业务系统中已有用户账户系统并且希望您业务系统中的用户账户在云视讯平台有唯一的用户标识,以便后期对用户的音视频呼叫进行管理,您可以使用第三方账号登录方法进行登录。 您可以使用您的应用系统中的用户账号登录云视讯平台,登录成功后平台将返回当前账户在云视讯平台的呼叫号码,后期该号码将作为该账户的唯一标识,每次登录后均使用同一呼叫号码,因此建议您将您应用系统的用户账户与云视讯平台的呼叫号码建立一一对应的关系并进行保存,以便在后期的业务场景中使用。 如果当前登录的账户在云视讯平台不存在,则平台将会注册一个新账户并登录,如果已经存在则使用已存在的账户进行登录。
有效期内三方账号数量默认支持十万,数量如不满足需求请联系小鱼支持人员。
如果您已经在小鱼管理后台创建了账户并希望使用小鱼系统账户登录,您可以使用小鱼账号登录方法进行登录。 已创建的小鱼账号统一在小鱼管理后台进行管理,包含账号所属组织机构的管理。
开发者可调用 loginExternalAccount 方法,进行第三方账号登录,参数如下:
SDK v3.10.3+之后,支持第三方Token登录方式,开发者可调用 loginExtToken 方法,参数如下:
登录完成后,通过监听事件LoginState获取登录状态信息;
三方企业获取authCode方式:小鱼提供jar包,客户根据jar包生成authcode授权码。用户在登录客户端SDK时,携带authcode,小鱼服务端校验准确性
在v3.10.3之前,通过调用 xyRTC 里面的 login 方法,进行小鱼账号登录
xyRTC.login(userName: string, password: string): result<IResult>;
interface IResult {
code: number;
msg: string;
data: object;
}
从v3.10.3+开始,建议使用 loginXYAccount 方法进行小鱼账号登录操作
xyRTC.loginXYAccount(params: IXYParams):IResult
/**
* 新的三方登录-小鱼账户
*
* @property {string} extID 企业id
* @property {string} countryCode 国家代码
* @property {string} account 账号
* @property {string} password 密码
*/
export interface IXYParams {
extID: string,
countryCode?: string,
account: string,
password: string
}
登录完成后,通过监听事件LoginState获取登录状态信息;
// 第三方企业账号登录,v3.10.3-
xyRTC.loginExternalAccount(extID, extUserId, displayName);
// 第三方企业账号登录,v3.10.3+
xyRTC.loginExternalAccount(
extID,
extUserId,
displayName,
authCode,
isTempUser
);
// 第三方企业Token登录, v3.10.3+
xyRTC.loginExtToken({ extID, token});
// 登录结果回调事件
xyRTC.on("LoginState", (e: ILoginState) => {});
interface ILoginState {
state: string; // Logined | Logining | logouting | Logouted
error: number;
info?: ILoingInfo;
}
interface ILoingInfo {
callUri: string;
displayName: string;
userId: number;
deviceId: number;
extUserId: string;
}