开发者中心 - 小鱼易连

本文档包含NemoSDK中所有账户服务相关的函数接口。

loginXYAccount

版本支持: 3.11.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

版本支持: 3.11.0

函数概述: token登录

函数定义:

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

函数参数:

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

loginExtUserId

版本支持: 3.11.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

版本支持: 3.11.0

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

函数状态: 已废弃, 请使用 loginXYLinkAccount(const char* userName, const char* password, const char* enhancePassword = "false")

函数定义:

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

版本支持: 3.11.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	是否需要验证密码安全策略

函数状态: 已废弃, 请使用 loginXYLinkByVerifyCode(const char* phoneNum, const char* identificationNum, const char* account = "", bool needVerifyPwdSecurity = true)

loginExternalAccount

版本支持: 3.11.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	是否是分区云5.3环境

anomousLogin

版本支持: 3.11.0

函数概述: 链接入会匿名登录

函数定义:

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

函数参数:

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

login

版本支持: 3.11.0

函数概述: token登录

函数定义:

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

函数参数:

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

oauthCodeLogin

版本支持: 3.11.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

版本支持: 3.11.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

版本支持: 3.11.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

版本支持: 3.11.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

版本支持: 3.11.0

函数概述: 自动登录(有cache使用cache，无cache重新调用账号密码登录)

函数定义:

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

函数参数:

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

loginWithAuthCode

版本支持: 3.3.0

函数概述: 认证登录

函数定义:

virtual void loginWithAuthCode(const char* extID, const char* extUserId, const char* oauthCode,
    bool tempUser, const char* channelId, const char* displayName) = 0;

函数参数:

参数名	类型	必填	默认值	描述
extID	const char*	是	无	企业id
extUserId	const char*	是	无	userid
oauthCode	const char*	是	无	授权码
tempUser	bool	是	无	true: 临时用户, false: 永久用户
channelId	const char*	是	无	渠道号
displayName	const char*	是	无	用户昵称, 会中显示

logout

版本支持: 3.3.0

函数概述: 登出

函数定义:

virtual void logout() = 0;

sendVerifyCodeShortMessage

版本支持: 3.11.0

函数概述: 获取验证码

函数定义:

virtual void sendVerifyCodeShortMessage(const char* accountNum, const char* account, const XYVerificationCodeType& type, const XYVerificationCodeDevice& device) = 0;

函数参数:

参数名	类型	必填	默认值	描述
accountNum	const char*	是	无	账号
account	const char*	是	无	账号名称（定制项目）
type	const XYVerificationCodeType&	是	无	获取验证码的使用场景
device	const XYVerificationCodeDevice&	是	无	设备类型

checkVerifyCode

版本支持: 3.11.0

函数概述: 验证验证码是否正确

函数定义:

virtual void checkVerifyCode(const char* phone, const char* verificationCode) = 0;

函数参数:

参数名	类型	必填	默认值	描述
phone	const char*	是	无	手机号
verificationCode	const char*	是	无	验证码

getVerifyImage

版本支持: 3.11.0

函数概述: 获取图形验证码

函数定义:

virtual void getVerifyImage(const char* platformUi) = 0;

函数参数:

参数名	类型	必填	默认值	描述
platformUi	const char*	是	无	平台类型

checkVerifyImage

版本支持: 3.11.0

函数概述: 检验图图形验证码拖拽位置是否正确

函数定义:

virtual void checkVerifyImage(const char* platformUi, const char* rid, int moveX, XYArray yMoveList) = 0;

函数参数:

参数名	类型	必填	默认值	描述
platformUi	const char*	是	无	平台类型
rid	const char*	是	无	图片id
moveX	int	是	无	水平方向的移动距离
yMoveList	XYArray	是	无	垂直方向偏移量

forgotPassword

版本支持: 3.11.0

函数概述: 忘记密码修改新密码

函数定义:

virtual void forgotPassword(const char* account, const char* newPwd, const char* verificationCode, const XYVerificationCodeDevice& device) = 0;

函数参数:

参数名	类型	必填	默认值	描述
account	const char*	是	无	账号
newPwd	const char*	是	无	新密码
verificationCode	const char*	是	无	验证码
device	const XYVerificationCodeDevice&	是	无	设备类型

changePassword

版本支持: 3.11.0

函数概述: 修改密码

函数定义:

virtual void changePassword(const char* account, const char* oldPwd, const char* newPwd, const char* verificationCode = "") = 0;

函数参数:

参数名	类型	必填	默认值	描述
account	const char*	是	无	账号
oldPwd	const char*	是	无	旧密码
newPwd	const char*	是	无	新密码
verificationCode	const char*	否	""	验证码

updateProfile

版本支持: 3.11.0

函数概述: 修改用户信息(仅限小鱼账号)

函数定义:

virtual void updateProfile(XYUserProfileType type, const char* value) = 0;

函数参数:

参数名	类型	必填	默认值	描述
type	XYUserProfileType	是	无	修改信息的类型
value	const char*	是	无	修改内容（XYUserProfileType = XYUserProfileType_PHOTO是传入文件路径, 其他类型是为要修改的内容）

deleteUserAvatar

版本支持: 3.11.0

函数概述: 删除用户自定义头像(仅限小鱼账号)

函数定义:

virtual void deleteUserAvatar(const std::string& info) = 0;

函数参数:

参数名	类型	必填	默认值	描述
info	const std::string&	是	无	预留字段，暂时不需要

getEnterpriseDomainName

版本支持: 3.11.0

函数概述: 根据邮箱获取企业域名

函数定义:

virtual void getEnterpriseDomainName(const char* email) = 0;

函数参数:

参数名	类型	必填	默认值	描述
email	const char*	是	无	邮箱

getEnterpriseConfig

版本支持: 3.11.0

函数概述: 获取企业配置. 目前只用来获取企业是否开启强密码

函数定义:

virtual void getEnterpriseConfig(const char* phoneNum) = 0;

函数参数:

参数名	类型	必填	默认值	描述
phoneNum	const char*	是	无	手机号

getUnreadNotificationMsgsCount

版本支持: 3.11.0

函数概述: 获取消息中心未读数

函数定义:

virtual void getUnreadNotificationMsgsCount() = 0;

getThirdPlatforms

版本支持: 3.11.0

函数概述: 获取支持的三方平台列表

函数定义:

virtual void getThirdPlatforms() = 0;

getClientConfig

版本支持: 3.11.0

函数概述: 聚合接口获取相关配置

函数定义:

virtual void getClientConfig(const char* configType) = 0;

函数参数:

参数名	类型	必填	默认值	描述
configType	const char*	是	无	获取配置类型可以获取所有配置也可以获取部分配置（all, uiCustomization, enterpriseConfig, accountStatus...）

getServerConfig

版本支持: 3.11.0

函数概述: 获取服务器配置信息（主动调用是在登录成功后调用，此函数针对断网再连接时手工调用）

函数定义:

virtual void getServerConfig() = 0;

getExclusiveNameCharacters

版本支持: 3.11.0

函数概述: 获取特殊字符正则表达式

函数定义:

virtual void getExclusiveNameCharacters() = 0;

getDefaultNameCharacters

版本支持: 3.11.0

函数概述: 获取默认特殊字符正则表达式

函数定义:

virtual void getDefaultNameCharacters() = 0;

getLiveDomainUrl

版本支持: 3.11.0

函数概述: 获取直播独立域名

函数定义:

virtual void getLiveDomainUrl() = 0;

getMeetingRoomConfig

版本支持: 3.11.0

函数概述: 获取会议室配置信息(仅限小鱼账号)

函数定义:

virtual void getMeetingRoomConfig() = 0;

updateConfConfig

版本支持: 3.11.0

函数概述: 更新会议室配置信息(仅限小鱼账号)

函数定义:

virtual void updateConfConfig(const char* meetingRoomInfo, const char* roomId) = 0;

函数参数:

参数名	类型	必填	默认值	描述
meetingRoomInfo	const char*	是	无	配置信息
roomId	const char*	是	无	会议室ID

getConfConfigAboutScheduledCall

版本支持: 3.11.0

函数概述: 查询会议是否仅预约呼叫

函数定义:

virtual void getConfConfigAboutScheduledCall(const char* confNum) = 0;

函数参数:

参数名	类型	必填	默认值	描述
confNum	const char*	是	无	会议号

updateConfConfigAboutScheduledCall

版本支持: 3.11.0

函数概述: 更新会议是否仅预约呼叫

函数定义:

virtual void updateConfConfigAboutScheduledCall(const char* config, const char* confNum) = 0;

函数参数:

参数名	类型	必填	默认值	描述
config	const char*	是	无	配置信息
confNum	const char*	是	无	会议号

getConfCapacity

版本支持: 3.11.0

函数概述: 查询会议容量

函数定义:

virtual void getConfCapacity(const char* confNum) = 0;

函数参数:

参数名	类型	必填	默认值	描述
confNum	const char*	是	无	会议号

setRecoveryConfAfterReconnection

版本支持: 3.11.0

函数概述: 云会议断线重呼设置

函数定义:

virtual void setRecoveryConfAfterReconnection(bool recovery) = 0;

函数参数:

参数名	类型	必填	默认值	描述
recovery	bool	是	无	是否开启断线重呼叫

setNoDisturbInCall

版本支持: 3.11.0

函数概述: 通话中免打扰设置

函数定义:

virtual void setNoDisturbInCall(bool noDisturb) = 0;

函数参数:

参数名	类型	必填	默认值	描述
noDisturb	bool	是	无	是否开启免打扰

setNoDisturbInHosting

版本支持: 3.11.0

函数概述: 主持会议免打扰设置

函数定义:

virtual void setNoDisturbInHosting(bool noDisturb) = 0;

函数参数:

参数名	类型	必填	默认值	描述
noDisturb	bool	是	无	是否开启免打扰

loginXYLinkAccount

版本支持: 3.3.0

函数状态: 已废弃, 请使用 loginXYLinkAccount(const char* userName, const char* password, const char* enhancePassword = "false")

函数概述: 使用该企业下的 XYLINK 账号登录（小鱼账号必须属于 SDK 开通时所绑定的企业，否则将鉴权失败）

函数定义:

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

函数参数:

参数名	类型	必填	默认值	描述
userName	const char*	是	无	用户名（小鱼账号）
password	const char*	是	无	密码

loginXYLinkByVerifyCode

版本支持: 3.3.0

函数状态: 已废弃, 请使用 loginXYLinkByVerifyCode(const char* phoneNum, const char* identificationNum, const char* account = "", bool needVerifyPwdSecurity = true)

函数定义:

virtual void loginXYLinkByVerifyCode(const char* phoneNum, const char* identificationNum) = 0;

函数参数:

参数名	类型	必填	默认值	描述
phoneNum	const char*	是	无	手机号
identificationNum	const char*	是	无	验证码

loginExternalAccount

版本支持: 3.3.0

函数状态: 已废弃, 请使用 loginExternalAccount(const char* extID, const char* extUserId, const char* displayName, bool is53 = false)

函数定义:

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

函数参数:

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

loginWithAuthCode

版本支持: 3.3.0

函数概述: 认证登录

函数定义:

virtual void loginWithAuthCode(const char* extID, const char* extUserId, const char* oauthCode, bool tempUser, const char* channelId, const char* displayName) = 0;

函数参数:

参数名	类型	必填	默认值	描述
extID	const char*	是	无	企业id
extUserId	const char*	是	无	userid
oauthCode	const char*	是	无	授权码
tempUser	bool	是	无	true: 临时用户, false: 永久用户
channelId	const char*	是	无	渠道号
displayName	const char*	是	无	用户昵称, 会中显示

2025-09-02 16:37:23

导出PDF文档