IM即时通讯

类型定义

InitConfig

初始化 SDK 设置的各项参数

参数 类型 说明
sdkServer String SDK 的 API 地址
dataDir String 客户端数据存放目录,例如:/Users/abcd/im
logLevel int SDK 日志级别,默认 6
isLogStandardOutput bool 是否将日志打印到控制台
logFilePath String? 指定本地保存日志文件路径,默认数据目录

AtUserInfo

at 成员信息

参数 类型 说明
atUserID String at 成员的 ID
groupNickname String at 成员的群昵称

AtTextElem

at 文本消息元素

参数 类型 说明
text String 消息内容
atUserList List<String> 被 at 的用户 ID 列表
atUsersInfo List<AtUserInfo> 被 at 的用户信息列表
quoteMessage Message 引用的消息内容

GroupHasReadInfo

群消息已读信息

参数 类型 说明
hasReadCount int 已读总数
unreadCount int 未读总数

AttachedInfoElem

附加消息内容

参数 类型 说明
groupHasReadInfo GroupHasReadInfo 已读消息的群成员信息
isPrivateChat bool 是否为私聊(阅后即焚)
burnDuration int 阅后即焚时间(秒)
hasReadTime int 已读的时间点
notSenderNotificationPush bool 不发推送消息

ConversationInfo

会话信息

参数 类型 说明
conversationID String 会话 ID
conversationType int 会话类型,参见 ConversationType
userID String? 用户 ID(单聊时有效)
groupID String? 群组 ID(群聊时有效)
showName String? 会话显示的名称
faceURL String? 头像 URL
recvMsgOpt int 消息接收方式,参见 MessageReceiveOpt
unreadCount int 未读数
groupAtType int? at 类型
latestMsgSendTime int? 最近消息的发送时间
draftText String? 草稿内容
draftTextTime int? 生成草稿的时间
isPinned bool? 是否为置顶状态
isPrivateChat bool? 是否开启了阅后即焚
burnDuration int? 阅后即焚的时长(秒)
isMsgDestruct bool? 是否开启消息销毁
msgDestructTime int? 消息销毁时间(秒)
isNotInGroup bool? 是否已不在组内(true: 已不在群内)
latestMsg Message 最近的一条消息
ex String? 应用层扩展内容

ConversationParams

设置会话参数

参数 类型 说明
userID String? 用户 ID
groupID String? 群组 ID
recvMsgOpt int? 消息接收方式
isPinned bool? 是否置顶
isPrivateChat bool? 是否开启阅后即焚
burnDuration int? 阅后即焚时长(秒)
groupAtType int? at 类型
ex String? 应用层扩展内容

CustomElem

自定义消息内容

参数 类型 说明
data String? 文本内容,JSON 字符串
ext String? 扩展内容,JSON 字符串,可为空
description String? 描述信息,JSON 字符串,可为空

FaceElem

表情消息

参数 类型 说明
index int? 表情的下标位置,发送端对接收端自定义内嵌的表情包
data String? 其他表情,如 URL 表情直接返回 URL

FileElem

文件消息内容

参数 类型 说明
filePath String? 文件本地路径
uuid String? 唯一 ID,可为空
sourceUrl String? 文件地址
fileName String? 文件名称
fileSize int? 文件大小

FriendApplicationInfo

好友申请信息

参数 类型 说明
fromUserID String? 发起者 userID
fromNickname String? 发起者昵称
fromFaceURL String? 发起者头像 URL
toUserID String? 被添加者 userID
toNickname String? 被添加者昵称
toFaceURL String? 被添加者头像 URL
handleResult int? 申请的处理结果(-1 已拒绝 / 0 未处理 / 1 已同意)
reqMsg String? 申请添加好友时的申请内容
createTime int? 发起申请的时间
handlerUserID String? 处理人的 userID
handleMsg String? 处理好友申请时的审批消息
handleTime int? 处理时间
ex String? 应用层扩展内容

UpdateFriendsReq

批量更新好友信息请求

参数 类型 说明
friendUserIDs List<String> 好友的 userID 列表
ex String? 扩展字段
remark String? 备注
isPinned bool? 是否置顶

PublicUserInfo

用户公开信息,包含基本信息,不包含手机等隐私字段

参数 类型 说明
userID String? 用户 ID
nickname String? 用户昵称
faceURL String? 头像 URL
appManagerLevel int? 应用管理员等级
ex String? 应用层扩展内容

BlacklistInfo

黑名单信息,注意黑名单是双向关系

参数 类型 说明
userID String? 用户 ID
nickname String? 用户昵称
faceURL String? 头像 URL
ownerUserID String? 本人的 userID
blockUserID String? 被拉黑的 userID
gender int? 性别
createTime int? 拉黑时间
addSource int? 拉黑方式
operatorUserID String? 操作拉黑的 userID
ex String? 应用层扩展内容

FriendInfo

好友用户基本信息

参数 类型 说明
userID String? 用户 ID
nickname String? 用户昵称
faceURL String? 头像 URL
ownerUserID String? 本人的 userID
friendUserID String? 好友的 userID
remark String? 好友备注
createTime int? 成为好友的时间
addSource int? 成为好友的方式
operatorUserID String? 使双方成为好友的 userID
isPinned bool 是否置顶
attachedInfo String? 暂未实现
ex String? 应用层扩展内容

FriendshipInfo

好友关系检查结果

参数 类型 说明
userID String? 用户 ID
result int? 1 表示好友关系且不在黑名单

SearchFriendsInfo

搜索好友信息,FriendInfo 的子类

参数 类型 说明
relationship int 用户关系,参见 Relationship

GroupApplicationInfo

申请入群信息

参数 类型 说明
groupID String? 群组 ID
groupName String? 群名称
notification String? 群公告
introduction String? 群简介
groupFaceURL String? 群头像 URL
createTime int? 申请入群的时间
status int? 群状态,0 正常 / 1 禁止聊天 / 2 已解散 / 3 禁言
creatorUserID String? 建群人 userID
ownerUserID String? 群主 userID
memberCount int? 群成员数量
userID String? 进群申请者 userID
nickname String? 进群申请者昵称
userFaceURL String? 进群申请者头像 URL
gender int? 进群者性别
handleResult int? 处理结果(-1 已拒绝 / 0 未处理 / 1 已同意)
reqMsg String? 申请加群的申请内容
handledMsg String? 处理申请的审批内容
reqTime int? 申请进群的时间
handleUserID String? 处理进群的 userID
handledTime int? 处理申请的时间
ex String? 应用层扩展内容
inviterUserID String? 邀请进群 userID
joinSource int? 进群方式,参见 JoinType

GroupInfo

群组信息

参数 类型 说明
groupID String 群组 ID(必填)
groupName String? 群名称
notification String? 群公告
introduction String? 群简介
faceURL String? 群头像 URL
ownerUserID String? 所有者 userID
createTime int? 群创建的时间
memberCount int? 群成员数量
status int? 群状态,0 正常 / 1 禁止聊天 / 2 已解散 / 3 禁言
creatorUserID String? 创建者 userID
groupType int? 群类型
needVerification int? 进群验证方式,参见 GroupVerification
lookMemberInfo int? 是否允许查看其他群成员的信息(0 允许 / 1 禁止)
applyMemberFriend int? 是否可以添加群成员为好友(0 允许 / 1 禁止)
notificationUpdateTime int? 群公告更新的时间
notificationUserID String? 群公告发布者 userID
ex String? 应用层扩展内容

GroupMembersInfo

群成员信息

参数 类型 说明
groupID String? 群组 ID
userID String? 群成员 ID
nickname String? 群成员昵称
faceURL String? 群成员头像 URL
roleLevel int? 群成员身份,参见 GroupRoleLevel
joinTime int? 群成员进群的时间
joinSource int? 群成员进群方式(2 邀请 / 3 搜索 / 4 二维码)
operatorUserID String? 同意进群的 userID
muteEndTime int? 禁言结束时间(秒)
inviterUserID String? 邀请者 userID
ex String? 应用层扩展内容

GroupMemberRole

群成员角色信息

参数 类型 说明
userID String? 群成员 ID
roleLevel int? 群成员身份(1 普通成员 / 2 群主 / 3 管理员)

LocationElem

定位消息内容

参数 类型 说明
description String? 位置描述内容
longitude double? 经度
latitude double? 纬度

MergeElem

合并消息内容

参数 类型 说明
title String? 标题
abstractList List<String>? 需要显示的前几条消息的摘要
multiMessage List<Message>? 选择合并的消息内容列表

AdvancedTextElem

高级文本消息内容

参数 类型 说明
text String? 消息内容
messageEntityList List<MessageEntity>? 消息实体列表

MessageEntity

消息实体

参数 类型 说明
type String? 类型
offset int? 偏移
length int? 长度
url String? URL
ex String? 扩展信息

TextElem

文本消息内容

参数 类型 说明
content String? 文本内容

CardElem

名片消息内容

参数 类型 说明
userID String? 用户 ID
nickname String? 用户昵称
faceURL String? 头像 URL
ex String? 应用层扩展内容

TypingElem

正在输入消息内容

参数 类型 说明
msgTips String? 提示的内容

OfflinePushInfo

离线推送消息内容

参数 类型 说明
title String? 推送标题
desc String? 推送描述
iOSPushSound String? 推送铃声文件的名称
iOSBadgeCount bool? 是否展示角标
ex String? 应用层扩展内容

Message

消息结构体

参数 类型 说明
clientMsgID String? 客户端消息 ID(唯一标识)
serverMsgID String? 服务端消息 ID
createTime int? 创建消息的时间
sendTime int? 发送消息的时间
sessionType int? 会话类型,参见 ConversationType
sendID String? 发送消息者 ID
recvID String? 接收消息者 ID
msgFrom int? 消息来源级别,参见 MessageLevel
contentType int? 消息类型,参见 MessageType
senderPlatformID int? 平台 ID
senderNickname String? 发送者昵称
senderFaceUrl String? 发送者头像 URL
groupID String? 群组 ID
seq int? 消息的 seq
isRead bool? 已读标识
hasReadTime int? 已读的时间
status int? 消息发送的状态,参见 MessageStatus
localEx String? 消息本地扩展字段
attachedInfo String? 附加信息
ex String? 扩展信息
offlinePush OfflinePushInfo 离线消息推送内容
textElem TextElem 文本内容
cardElem CardElem 名片内容
pictureElem PictureElem 图片消息内容
soundElem SoundElem 语音消息内容
videoElem VideoElem 视频消息内容
fileElem FileElem 文件消息内容
mergeElem MergeElem 合并消息内容
atTextElem AtTextElem at 消息内容
locationElem LocationElem 地理位置内容
quoteElem QuoteElem 引用消息内容
customElem CustomElem 自定义消息内容
notificationElem NotificationElem 通知消息内容
faceElem FaceElem 自定义表情内容
attachedInfoElem AttachedInfoElem 附加消息内容
advancedTextElem AdvancedTextElem 高级文本内容
typingElem TypingElem 正在输入消息内容

ReadReceiptInfo

消息已读回执

参数 类型 说明
userID String? 已读用户 ID,仅单聊时有效
groupID String? 已读群聊 ID,仅群聊时有效
msgIDList List<String>? 已读消息 ID 列表
readTime int? 接收者阅读消息的时间点
msgFrom int? 消息来源,参见 MessageLevel
contentType int? 消息类型,参见 MessageType
sessionType int? 会话类型,参见 ConversationType

RevokedInfo

撤回信息

参数 类型 说明
revokerID String? 撤回者的用户 ID
revokerNickname String? 撤回者昵称
revokerRole int? 群消息撤回者的身份,参见 GroupRoleLevel
clientMsgID String? 客户端消息 ID
revokeTime int? 撤回的时间
sourceMessageSendTime int? 消息发送的时间
sourceMessageSendID String? 消息发送者 userID
sourceMessageSenderNickname String? 消息发送者昵称
sessionType int? 会话类型,参见 ConversationType

NotificationElem

通知消息内容

参数 类型 说明
detail String? 详情
defaultTips String? 默认提示

PictureInfo

图片信息描述

参数 类型 说明
uuid String? 唯一 ID,可为空
type String? 图片类型,可为空
size int? 图片大小
width int? 图片宽度
height int? 图片高度
url String? 图片 URL 地址

PictureElem

图片消息内容

参数 类型 说明
sourcePath String? 本地路径
sourcePicture PictureInfo 本地图片详情
bigPicture PictureInfo 大图详情
snapshotPicture PictureInfo 缩略图详情

QuoteElem

引用消息内容

参数 类型 说明
text String? 回复的消息内容
quoteMessage Message 被引用的消息

SearchParams

查找消息列表参数

参数 类型 说明
conversationID String? 会话 ID
clientMsgIDList List<String>? 客户端消息 ID 列表

SearchResult

本地消息搜索结果

参数 类型 说明
totalCount int? 总消息数量
searchResultItems List<SearchResultItems>? 搜索结果列表
findResultItems List<SearchResultItems>? 查找结果列表

SearchResultItems

搜索结果的 item

参数 类型 说明
conversationID String? 会话 ID
conversationType int? 会话类型,参见 ConversationType
showName String? 展示的昵称
faceURL String? 头像 URL
messageCount int? 消息数量
messageList List<Message>? 消息列表

AdvancedMessage

历史消息查询返回结果

参数 类型 说明
messageList List<Message>? 消息列表
isEnd bool? 是否查询完
lastMinSeq int? 上一次拉取回调给的值
errCode int? 错误码
errMsg String? 错误信息

SoundElem

语音消息内容

参数 类型 说明
uuid String? 唯一 ID
soundPath String? 本地路径
sourceUrl String? 音频文件 URL
dataSize int? 音频文件大小
duration int? 音频文件时长(秒)

UserInfo

个人信息

参数 类型 说明
userID String? 用户 ID
nickname String? 用户昵称
faceURL String? 用户头像 URL
createTime int? 用户注册的时间(秒)
remark String? 备注
ex String? 应用层扩展内容
globalRecvMsgOpt int? 全局消息接收方式设置(0 正常 / 1 不接收消息 / 2 只接收在线消息)

FullUserInfo

完整用户信息(包含公开信息、好友信息、黑名单信息)

参数 类型 说明
publicInfo PublicUserInfo? 用户公开信息
friendInfo FriendInfo? 好友信息(仅好友时有值)
blackInfo BlacklistInfo? 黑名单信息(仅在黑名单时有值)

UserStatusInfo

用户状态信息

参数 类型 说明
userID String? 用户 ID
status int? 状态,0 表示离线,1 表示在线
platformIDs List<int>? 平台 ID 列表

LocalUserCommand

本地用户命令

参数 类型 说明
userID String? 用户 ID
type int? 命令类型
uuid String? 唯一 ID
createTime int? 创建时间
value String? 值
ex String? 扩展信息

VideoElem

视频消息内容

参数 类型 说明
videoPath String? 视频本地路径
videoUUID String? 视频 ID
videoUrl String? 视频 URL
videoType String? 视频类型(MIME)
videoSize int? 视频大小
duration int? 视频时长(秒)
snapshotPath String? 视频快照本地路径
snapshotUUID String? 视频快照 ID
snapshotSize int? 视频快照大小
snapshotUrl String? 视频快照 URL
snapshotWidth int? 视频快照宽度
snapshotHeight int? 视频快照高度