com.seeyon.apps.uc.api

接口 ZxApi

所有已知实现类:

AbstractZxApi

public interface ZxApi

UC接口

方法概要

限定符和类型	方法和说明
java.util.Map<java.lang.String,java.lang.Object>	afterComplete(java.util.Map<java.lang.String,java.lang.String> param) 登录验证前后的拦截器接口实现
java.lang.String	appWakeup(java.util.Map<java.lang.String,java.lang.String> param) 即时会议唤醒 参数传入示例： Map param = Maps.newHashMap(); param.put("appName", "tencentMeeting"); param.put("id", "287-889-492"); param.put("pwd", "123456");
java.lang.String	autoPierce(java.lang.String url) 移动端唤醒PC浏览器穿透
java.util.Map<java.lang.String,java.util.HashSet<java.lang.String>>	batchGetGroupMemberIds(java.util.Collection<java.lang.Long> groupIds) 批量获取群组中的成员
java.util.Map<java.lang.String,java.lang.String>	getEntUserPcUrl(java.lang.String json) 代替getPcUrl(Ent_UserMessage message) 获取致信消息对象
java.util.Map<java.lang.String,java.lang.Object>	getGroupAuth(java.lang.String groupId, java.lang.String memberId, java.lang.String groupAuthType) 判断当前人在当前群组是否有文件操作权限
ZxGroupInfoBO	getGroupInfo(java.lang.Long groupId, java.lang.Long memberId) 获取群组信息
java.util.Map<java.lang.Long,ZxGroupInfoBO>	getGroupInfoForPortal(java.util.List<java.lang.Long> groupIds)
java.lang.String[]	getGroupMemberIdArray(java.lang.String groupId) 获取群主成员id数组
java.util.Set<java.lang.Long>	getGroupMemberIds(java.lang.Long groupId) 获取群组人员列表
java.util.Map<java.lang.String,java.lang.String>	getLoginC2sUC(java.lang.String memberId) 获取致信中人员登陆信息(客户端连接) 正常: 1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常: 2、不能取到jid、token、port、extranetIp、 intranetIp
int	getRegisterNum() 获取致信总授权数
int	getRongState(java.lang.String memberId) 返回融云用户状态
java.lang.String	getUcRongCacheValue(java.lang.String key) 获取初始化融云数据中存储的值
java.util.Map<java.lang.String,java.lang.String>	getUserHistoryPcUrl(java.lang.String json) 代替getPcUrl(UserHistoryMessage message) 获取致信消息对象
boolean	isOpenBusinessPush() 判断是否开启业务消息推送
boolean	isRong() 判断当前通道是否是融云通道 融云通道：true local：false
java.util.Map<java.lang.String,java.lang.String>	kickZx(java.lang.String memberId) 给m3踢致信用
java.lang.Integer	publishMobilePrivateDonotPush(java.lang.String sendId, java.lang.String[] toIds, java.lang.String content, java.lang.String extra, java.lang.String pushContent, java.lang.String pushData, java.lang.String count, java.lang.Integer verifyBlacklist, java.lang.Integer isPersisted, java.lang.Integer isCounted, java.lang.Integer isIncludeSender) 发送移动消息消息
java.util.Map<java.lang.String,java.lang.String>	synchronousUserLogin(java.lang.String memberId, java.lang.String connectType) 登录用户,并返回用户登录信息
java.lang.String	txMeetingCard(java.lang.Long senderId, java.lang.String receiverIds, java.lang.String meetingLink, java.lang.String meetingLinkPwd) 腾讯会议发送卡片
boolean	validateMessageCardAuth(java.lang.Long currentMemberId, java.lang.Long zxMessageId) 检验当前应用穿透有没有致信权限

方法详细资料

publishMobilePrivateDonotPush

java.lang.Integer publishMobilePrivateDonotPush(java.lang.String sendId,
                                                java.lang.String[] toIds,
                                                java.lang.String content,
                                                java.lang.String extra,
                                                java.lang.String pushContent,
                                                java.lang.String pushData,
                                                java.lang.String count,
                                                java.lang.Integer verifyBlacklist,
                                                java.lang.Integer isPersisted,
                                                java.lang.Integer isCounted,
                                                java.lang.Integer isIncludeSender)

发送移动消息消息

参数:

fromUserId:发送人用户 - Id。（必传）

toUserId:接收用户 - Id，可以实现向多人发送消息，每次上限为 1000 人。（必传）

content: - mobileOAMessage内的消息内容

extra: - mobileOAMessage内的扩展内容

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息。如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

count:针对 - iOS 平台，Push 时用来控制未读消息显示数，只有在 toUserId 为一个用户 Id 的时候有效。（可选）

verifyBlacklist:是否过滤发送人黑名单列表，0 - 表示为不过滤、 1 表示为过滤，默认为 0 不过滤。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

isIncludeSender:发送用户自已是否接收消息，0 - 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）

返回:

CodeSuccessResult

getUcRongCacheValue

java.lang.String getUcRongCacheValue(java.lang.String key)

获取初始化融云数据中存储的值

参数:

key - "uc_Channel"：通道,"uc_deployment":部署方式，公有云/私有云.... 具体参考UcConstants类中以UC_为前缀的常量

返回:

getGroupMemberIdArray

java.lang.String[] getGroupMemberIdArray(java.lang.String groupId)

获取群主成员id数组

参数:

groupId - 群组编号 正常:
1、成功获取群组成员编号数组
异常:
2、失败返回null

返回:

getRongState

int getRongState(java.lang.String memberId)

返回融云用户状态

参数:

memberId - 人员id Long

返回:

0：正常；1：未授权；2：已过期 Int

synchronousUserLogin

java.util.Map<java.lang.String,java.lang.String> synchronousUserLogin(java.lang.String memberId,
                                                                      java.lang.String connectType)

登录用户,并返回用户登录信息

参数:

memberId - 用户编号

connectType - 连接类型

返回:

getGroupAuth

java.util.Map<java.lang.String,java.lang.Object> getGroupAuth(java.lang.String groupId,
                                                              java.lang.String memberId,
                                                              java.lang.String groupAuthType)

判断当前人在当前群组是否有文件操作权限

参数:

groupId - 群组id

memberId - 人员id

groupAuthType - 操作类型 sendfile,receivefile(不区分大小写)

返回:

getEntUserPcUrl

java.util.Map<java.lang.String,java.lang.String> getEntUserPcUrl(java.lang.String json)

代替getPcUrl(Ent_UserMessage message)

获取致信消息对象

参数:

json - A8 消息对象

返回:

Map 返回key定义

        mi：消息编号
  si：发送人编号
  sn：发送人姓名
  ui：接收人编号
  un：接收人名称
  c ：内容
  ml：pc穿透连接
  mml：移动穿透连接
  mc：消息分类（协同、公文
  mt：消息类型（系统消息、普通消息）
  t ：创建时间
  ir：已读/未读
 

getUserHistoryPcUrl

java.util.Map<java.lang.String,java.lang.String> getUserHistoryPcUrl(java.lang.String json)

代替getPcUrl(UserHistoryMessage message)

获取致信消息对象

参数:

json - A8 消息对象

json -

返回:

getLoginC2sUC

java.util.Map<java.lang.String,java.lang.String> getLoginC2sUC(java.lang.String memberId)
                                                        throws java.lang.Exception

获取致信中人员登陆信息(客户端连接)

正常:
1、传入人员ID获取用户上线信息包括jid、token、port、extranetIp、 intranetIp、 异常:
2、不能取到jid、token、port、extranetIp、 intranetIp

参数:

memberId -

返回:

抛出:

java.lang.Exception

isRong

boolean isRong()

判断当前通道是否是融云通道 融云通道：true local：false

返回:

isOpenBusinessPush

boolean isOpenBusinessPush()

判断是否开启业务消息推送

返回:

true：开启 false：关闭

getRegisterNum

int getRegisterNum()

获取致信总授权数

返回:

afterComplete

java.util.Map<java.lang.String,java.lang.Object> afterComplete(java.util.Map<java.lang.String,java.lang.String> param)

登录验证前后的拦截器接口实现

参数:

request -

response -

返回:

kickZx

java.util.Map<java.lang.String,java.lang.String> kickZx(java.lang.String memberId)

给m3踢致信用

参数:

memberId -

返回:

getGroupMemberIds

java.util.Set<java.lang.Long> getGroupMemberIds(java.lang.Long groupId)

获取群组人员列表

参数:

groupId -

返回:

getGroupInfo

ZxGroupInfoBO getGroupInfo(java.lang.Long groupId,
                           java.lang.Long memberId)

获取群组信息

参数:

groupId - 群组id

memberId - 当前人员 如果不需要获取有排序的人员列表 可以传null

返回:

getGroupInfoForPortal

java.util.Map<java.lang.Long,ZxGroupInfoBO> getGroupInfoForPortal(java.util.List<java.lang.Long> groupIds)

batchGetGroupMemberIds

java.util.Map<java.lang.String,java.util.HashSet<java.lang.String>> batchGetGroupMemberIds(java.util.Collection<java.lang.Long> groupIds)

批量获取群组中的成员

参数:

groupIds -

返回:

validateMessageCardAuth

boolean validateMessageCardAuth(java.lang.Long currentMemberId,
                                java.lang.Long zxMessageId)

检验当前应用穿透有没有致信权限

参数:

currentMemberId -

zxMessageId -

返回:

txMeetingCard

java.lang.String txMeetingCard(java.lang.Long senderId,
                               java.lang.String receiverIds,
                               java.lang.String meetingLink,
                               java.lang.String meetingLinkPwd)
                        throws com.seeyon.ctp.common.exceptions.BusinessException

腾讯会议发送卡片

返回:

抛出:

java.io.UnsupportedEncodingException

com.seeyon.ctp.common.exceptions.BusinessException

appWakeup

java.lang.String appWakeup(java.util.Map<java.lang.String,java.lang.String> param)

即时会议唤醒 参数传入示例： Map param = Maps.newHashMap(); param.put("appName", "tencentMeeting"); param.put("id", "287-889-492"); param.put("pwd", "123456");

返回:

autoPierce

java.lang.String autoPierce(java.lang.String url)

移动端唤醒PC浏览器穿透

参数:

url -

返回:

抛出:

java.io.UnsupportedEncodingException

com.seeyon.ctp.common.exceptions.BusinessException