开发者中心 - 小鱼易连

loginXYAccount

版本支持: v3.3.0+

接口概述: 账号登录(账号必须跟sdk开通时的所属企业相同, 否则会鉴权失败)

接口定义:

virtual void loginXYAccount(const char* extId, const char* countryCode, const char* account, const char* password) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extId	const char*	是	无	企业标志，联系小鱼销售人员获取
countryCode	const char*	是	无	国家码
account	const char*	是	无	用户名
password	const char*	是	无	密码

loginExtToken

版本支持: v3.3.0+

接口概述: token登录

接口定义:

virtual void loginExtToken(const char* extId, const char* token) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extId	const char*	是	无	企业标志，联系小鱼销售人员获取
token	const char*	是	无	token

loginExtUserId

版本支持: v3.3.0+

接口概述: 第三方账户登录

接口定义:

virtual void loginExtUserId(const char* extId, const char* displayName, const char* extUID, const char* authCode) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extId	const char*	是	无	企业标志，联系小鱼销售人员获取
displayName	const char*	是	无	显示名称，不能包含以下字符 ';' ':' ',' '=' '-' '(' ')' '[' ']' '{' '}' '@' '#' '*' '\' '\r' '\n' '\t'
extUID	const char*	是	无	方用户ID，同一企业不能相同
authCode	const char*	是	无	授权码

loginXYLinkAccount

版本支持: v3.3.0+

接口概述: 账号登录(账号必须跟sdk开通时的所属企业相同, 否则会鉴权失败)

接口定义:

virtual void loginXYLinkAccount(const char* userName, const char* password, const char* enhancePassword = "false") = 0;

接口参数:

参数名	类型	必填	默认值	描述
userName	const char*	是	无	用户名
password	const char*	是	无	密码
enhancePassword	const char*	否	"false"	是否为强密码

loginXYLinkByVerifyCode

版本支持: v3.3.0+

接口概述: 使用验证码登录（默认会验证密码安全策略，链接入会及加入会议登录时无需验证）

接口定义:

virtual void loginXYLinkByVerifyCode(const char* phoneNum, const char* identificationNum, const char* account = "", bool needVerifyPwdSecurity = true) = 0;

接口参数:

参数名	类型	必填	默认值	描述
phoneNum	const char*	是	无	手机号
identificationNum	const char*	是	无	验证码
account	const char*	否	""	账号
needVerifyPwdSecurity	bool	否	true	是否需要验证密码安全策略

loginExternalAccount

版本支持: v3.3.0+

接口概述: 使用第三方账户登录

接口定义:

virtual void loginExternalAccount(const char* extID, const char* extUserId, const char* displayName, bool is53 = false) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extID	const char*	是	无	企业标志，联系小鱼销售人员获取
extUserId	const char*	是	无	三方用户ID，同一企业不能相同
displayName	const char*	是	无	显示名称，不能包含以下字符 ';' ':' ',' '=' '-' '(' ')' '[' ']' '{' '}' '@' '#' '*' '\' '\r' '\n' '\t'
is53	bool	否	false	是否为53版本

loginExternalAccountOld

版本支持: v3.3.0+

接口概述: 老版本第三方登录为了兼容之前后续版本将弃用

接口定义:

virtual void loginExternalAccountOld(const char* extID, const char* extUserId, const char* displayName) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extID	const char*	是	无	企业标志，联系小鱼销售人员获取
extUserId	const char*	是	无	三方用户ID，同一企业不能相同
displayName	const char*	是	无	显示名称

anomousLogin

版本支持: v3.3.0+

接口概述: 链接入会匿名登录

接口定义:

virtual void anomousLogin(const char* displayName, bool onlyCustomizedCanaccessed) = 0;

接口参数:

参数名	类型	必填	默认值	描述
displayName	const char*	是	无	显示名称
onlyCustomizedCanaccessed	bool	是	无	是否仅自定义用户可以访问

login

版本支持: v3.3.0+

接口概述: token登录

接口定义:

virtual void login(const char* loginName, const XYTokenLoginParam& param) = 0;

接口参数:

参数名	类型	必填	默认值	描述
loginName	const char*	是	无	用户名
param	XYTokenLoginParam	是	无	token登录额外参数

oauthCodeLogin

版本支持: v3.3.0+

接口概述: 授权码登录

接口定义:

virtual void oauthCodeLogin(const char* extID, const char* extUserId, const char* oauthCode, const char* displayName) = 0;

接口参数:

参数名	类型	必填	默认值	描述
extID	const char*	是	无	企业id
extUserId	const char*	是	无	三方用户ID，同一企业不能相同
oauthCode	const char*	是	无	授权码
displayName	const char*	是	无	显示名称，不能包含以下字符 ';' ':' ',' '=' '-' '(' ')' '[' ']' '{' '}' '@' '#' '*' '\' '\r' '\n' '\t'

newUserRegistration

版本支持: v3.3.0+

接口概述: 新用户注册并自动登录

接口定义:

virtual void newUserRegistration(const char* email, const char* phone, const char* displayname, const char* password, const char* verifyCode, const char* enhance = "false") = 0;

接口参数:

参数名	类型	必填	默认值	描述
email	const char*	是	无	邮箱
phone	const char*	是	无	手机号
displayname	const char*	是	无	显示名称
password	const char*	是	无	密码
verifyCode	const char*	是	无	验证码
enhance	const char*	否	"false"	是否为强密码

SSOLogin

版本支持: v3.3.0+

接口概述: SSO登录

接口定义:

virtual void SSOLogin(const char* code, const char* type) = 0;

接口参数:

参数名	类型	必填	默认值	描述
code	const char*	是	无	登录唯一code 通过url scheme获取
type	const char*	是	无	SSO登录类型通过url scheme获取

thirdPartyLogin

版本支持: v3.3.0+

接口概述: 第三方登录

接口定义:

virtual void thirdPartyLogin(const char* code, const char* type, const char* personId) = 0;

接口参数:

参数名	类型	必填	默认值	描述
code	const char*	是	无	登录唯一code 通过url scheme获取
type	const char*	是	无	第三方登录类型通过url scheme获取
personId	const char*	是	无	用户ID 通过url scheme获取

autoLogin

版本支持: v3.3.0+

接口概述: 自动登录(有cache有cahce 无cache重新调用账号密码登录)

接口定义:

virtual void autoLogin(const char* account,const char* password,bool enhancePassword = false) = 0;

接口参数:

参数名	类型	必填	默认值	描述
account	const char*	是	无	账号
password	const char*	是	无	密码
enhancePassword	bool	否	false	是否为强密码

logout

版本支持: v3.3.0+

接口概述: 登出

接口定义:

virtual void logout() = 0;

2025-08-07 19:49:33

导出PDF文档