IM即时通讯

类型定义

ResponseData

通用回调参数

参数 类型 说明
errCode number 调用失败时的错误码
errMsg string 调用失败时的错误描述信息
data T 调用成功时的返回结果,作为泛型
operationID string 调用时传入的 operationID

PublicUserItem

用户公开信息,主要是基本信息,不包括手机等其它隐私字段

参数 类型 说明
userID string 用户 ID
nickname string 用户昵称
faceURL string 头像 URL

FriendUserItem

好友用户基本信息。

参数 类型 说明
userID string 用户 ID
nickname string 用户昵称
faceURL string 头像 URL
ownerUserID string 本人的 userID
remark string 好友备注
createTime number 成为好友的时间
addSource number 成为好友的方式
operatorUserID string 使双方成为好友的 uesrID
phoneNumber string 手机号码
birth string 生日
email string 邮箱
attachedInfo string 暂未实现
ex string 应用层扩展内容

BlackUserItem

黑名单信息,黑名单用户基本信息,注意黑名单是双向关系。

参数 类型 说明
userID string 用户 ID
nickname string 用户昵称
faceURL string 头像 URL
createTime number 拉黑时间
addSource number 拉黑方式
operatorUserID string 操作拉黑的 uesrID
attachedInfo string 暂未实现
ex string 应用层扩展内容

SearchedFriendsInfo

参数 类型 说明
userID string 用户 ID
nickname string 用户昵称
faceURL string 头像 URL
ownerUserID string 本人的 userID
remark string 好友备注
createTime number 成为好友的时间
addSource number 成为好友的方式
operatorUserID string 使双方成为好友的 uesrID
phoneNumber string 手机号码
birth string 生日
email string 邮箱
attachedInfo string 暂未实现
ex string 应用层扩展内容
relationship number 0 黑名成员,1 是好友

SelfUserInfo

参数 类型 说明
userID string 用户 ID
nickname string 用户昵称
faceURL string 用户头像
createTime number 用户注册时间
ex string 用户扩展字段
globalRecvMsgOpt MessageReceiveOptType 全局消息接收设置

UserOnlineState

参数 类型 说明
userID string 用户 ID
platformIDs Platform[] 登录的平台
status number 0 表示离线,1 表示在线

ConversationInfo

会话信息

参数 类型 说明
conversationID string 会话 ID
conversationType ConversationType 会话类型
userID string 用户 ID
groupID string 群组 ID
showName string 会话显示的名称
faceURL string 头像 URL
recvMsgOpt ReceiveMessageOpt 消息接收方式
unreadCount number 未读数
groupAtType GroupAtType @类型
latestMsgSendTime number 最近消息的发送时间
draftText string 草稿内容
draftTextTime number 生成草稿的时间
isPinned boolean 是否为置顶状态
isPrivateChat boolean 是否开启了阅后即焚
burnDuration number 阅后即焚的时长
isNotInGroup boolean 是否还在组内,true: 已不在群内
attachedInfo string 附加信息
latestMsg MessageInfo 最近的一条消息
ex string 应用层扩展内容

MessageInfo

消息结构体

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

TextElem

文本消息内容

参数 类型 说明
content string 文本内容

CardElem

卡片消息内容

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

SoundElem

语音消息内容

参数 类型 说明
uuID string 唯一 ID
soundPath string 本地路径
sourceUrl string 音频文件 URL
dataSize number 音频文件大小
duration number 音频文件时长

PictureElem

图片消息内容

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

VideoElem

参数 类型 说明
videoPath string 视频本地路径
videoUUID string 视频 ID
videoUrl string 视频 URL
videoType string 视频类型
videoSize number 视频大小
duration number 视频时长
snapshotPath string 视频快照本地路径
snapshotUUID string 视频快照 ID
snapshotSize number 视频快照大小
snapshotUrl string 视频快照 URL
snapshotWidth number 视频快照宽度
snapshotHeight number 视频快照高度

FileElem

文件消息内容

参数 类型 说明
filePath string 文件本地路径
uuID string 唯一 ID,可为空
sourceUrl string 图片地址
fileName string 文件名称
fileSize number 文件大小

PictureInfo

图片信息描述

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

MergeElem

合并消息内容

参数 类型 说明
title string 标题
abstractList string[] 需要显示的前几条消息的摘要
multiMessage MessageInfo[] 选择合并的消息内容列表

AtTextElem

at 文本元素

参数 类型 说明
text string 消息内容
atUserList string[] 被@的用户 ID 列表
atUsersInfo AtInfo[] 被@的用户信息列表
quoteMessage MessageInfo 引用的消息内容
isAtSelf string @的是否是自己
isAtAll string 是否@全体成员

LocationElem

定位消息内容

参数 类型 说明
desc string 位置描述内容
longitude number 经度
latitude number 纬度

QuoteElem

引用消息内容

参数 类型 说明
text string 回复的消息内容
quoteMessage MessageInfo 被引用的消息

CustomElem

自定义消息内容

参数 类型 说明
data string 文本内容
extension string 扩展内容
description string 描述信息

FaceElem

表情消息

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

AttachedInfoElem

附加消息内容

参数 类型 说明
groupHasReadInfo GroupHasReadInfo 已读消息的群成员信息
isPrivateChat boolean 是否为私聊
burnDuration number 阅后即焚时间
hasReadTime number 已读的时间点
notSenderNotificationPush boolean 不发推送消息
isEncryption boolean 是否加密
inEncryptStatus boolean 当前加密状态
uploadProgress UploadProgress 上传进度

UploadProgress

上传进度

参数 类型 说明
total number 上传总大小
save number 已存储大小
current number 当前上传大小

GroupHasReadInfo

群消息已读用户

参数 类型 说明
hasReadUserIDList string[] 已读的用户 ID 列表
hasReadCount number 已读总数
groupMemberCount number 当时发送此条消息的群人数

AdvancedTextElem

高级消息内容

参数 类型 说明
text string 消息内容

TypingElem

提示消息内容

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

FriendReq

好友申请信息

参数 类型 说明
fromUserID string 发起者 userID
fromNickname string 发起者昵称
fromFaceURL string 发起者头像 URL
fromGender Gender 发起者性别
toUserID string 被添加者 userID
toNickname string 被添加者昵称
toFaceURL string 被添加者头像 URL
toGender Gender 被添加者性别
handleResult ApplicationStatus 申请的处理结果
reqMsg string 申请添加好友时的申请内容
createTime number 发起申请的时间
handlerUserID string 处理人的 userID
handleMsg string 处理好友申请时的审批消息
handleTime number 处理时间
ex string 应用层扩展内容

SimpleResultInfo

参数 类型 说明
userID string 被添加者 userID
result number 1 是好友 0 非好友

SearchFriendsParam

查询好友使用,isSearchNickname,isSearchRemark 不可以同时为 false

参数 类型 说明
keywordList string[] 关键词列表,目前仅支持单个关键词
isSearchUserID boolean 是否以关键词搜索 userID
isSearchNickname boolean 是否以关键词搜索昵称,默认 false
isSearchRemark boolean 是否以关键词搜索备注,默认 false

GroupInfo

群组信息

参数 类型 说明
groupID string 群组 ID
groupName string 群名称
introduction string 群简介
faceURL string 群头像 URL
createTime number 群创建的时间
memberCount number 群成员数量
status GroupStatus 群状态
creatorUserID string 创建者 userID
ownerUserID string 所有者 userID
needVerification GroupVerificationType 进群验证方式
lookMemberInfo AllowType 是否允许查看其他群成员的信息
applyMemberFriend AllowType 是否可以添加群成员为好友
notification string 群公告
notificationUpdateTime number 群公告更新的时间
notificationUserID string 群公告发布者 userID
ex string 应用层扩展内容

GroupMemberInfo

群成员信息

参数 类型 说明
userID string 群成员 ID
roleLevel GroupMemberRole 群成员身份
groupID string 群组 ID
nickname string 群成员昵称
faceURL string 群成员头像 URL
joinTime number 群成员进群的时间
joinSource JoinType 群成员进群方式
operatorUserID string 同意进群的 userID
muteEndTime number 禁言结束时间
inviterUserID string 邀请者 userID
ex string 应用层扩展内容

GroupReqInfo

申请入群信息

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

AtInfo

at 成员信息

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

PicBaseInfo

图片信息

参数 类型 说明
uuid string 资源唯一 ID
type string 文件类型
size number 文件大小
width number 图像宽度
height number 图像高度
url string 图像地址,创建图片消息时可不传

OfflinePushInfo

离线推送消息内容

参数 类型 说明
title string 推送标题
desc string 推送描述
iOSPushSound string 推送铃声文件的名称
iOSBadgeCount boolean 是否展示角标
operatorUserID string 发送者用户 ID
ex string 应用层扩展内容

SearchResultInfo

查找本地消息结果

参数 类型 说明
totalCount number 总消息数量
searchResultItems SearchResultItemInfo[] 搜索结果列表

SearchResultItemInfo

查找本地消息结果的 item

参数 类型 说明
conversationID string 会话 ID
messageCount number 消息数量
conversationType ConversationType 会话类型
showName string 展示的昵称
faceURL string 头像 URL
messageList MessageInfo[] 消息列表

GetAdvancedHistoryMessageListInfo

查找历史消息的返回结果

参数 类型 说明
isEnd boolean 是否查询完
lastMinSeq number 上一次拉取回调给的值
errCode number 错误码
errMsg string 错误信息
messageList MessageInfo[] 消息列表

ReceiptInfo

消息回执

参数 类型 说明
userID string 已读用户 ID,仅单聊时有效
groupID string 已读群聊 ID,仅群聊时有效
msgIDList string[] 已读消息 ID 列表
readTime string 接收者阅读消息的时间点
msgFrom MessageLevel 消息来源
contentType MessageContentType 消息类型
sessionType ConversationType 会话类型

MessageRevokedInfo

撤回信息

参数 类型 说明
revokerID string 撤回者的用户 ID
revokerNickname string 撤回者昵称
revokerRole GroupMemberRole 群消息撤回者的身份
clientMsgID string 客户端消息 ID
revokeTime number 撤回的时间
sourceMessageSendTime number 消息发送的时间
sourceMessageSendID string 消息发送者 userID
sourceMessageSenderNickname string 消息发送者昵称
sessionType ConversationType 会话类型
ex string 应用层扩展信息