类型定义
更新时间: 2024/09/03 14:09:16AdvancedMsg
消息结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码 |
| errMsg | String | 错误信息 |
| lastMinSeq | int | 上一次拉取回调给的值 |
| isEnd | boolean | 是否最后 |
| messageList | List<Message> | 消息列表 |
PutArgs
上传参数
| 参数 | 类型 | 说明 |
|---|---|---|
| filepath | String | 本地文件路径 |
| name | String | 文件名 |
NotDisturbInfo
会话结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationId | String | 会话id |
| result | String | 免打扰状态1:屏蔽消息; 2:接收消息但不提示; 0:正常 |
AtUserInfo
at信息结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| atUserID | String | at成员的ID |
| groupNickname | String | at成员的群昵称 |
ReadReceiptInfo
消息回执
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | String | 已读用户ID，仅单聊时有效 |
| groupID | String | 已读群聊ID，仅群聊时有效 |
| msgIDList | List |
已读消息ID列表 |
| readTime | String | 接收者阅读消息的时间点 |
| msgFrom | int | 消息来源 |
| contentType | int | 消息类型 |
| sessionType | int | 会话类型 |
AtTextElem
at文本元素
| 参数 | 类型 | 说明 |
|---|---|---|
| text | String | 消息内容 |
| atUserList | List |
被@的用户ID列表 |
| atUsersInfo | List<AtUserInfo> | 被@的用户信息列表 |
| isAtSelf | String | @的是否是自己 |
GrpHasReadInfo
群消息已读用户
| 参数 | 类型 | 说明 |
|---|---|---|
| hasReadUserIDList | List |
已读的用户ID列表 |
| hasReadCount | int | 已读总数 |
| groupMemberCount | int | 当时发送此条消息的群人数 |
AttachedInfoElem
附加消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| groupHasReadInfo | GrpHasReadInfo | 已读消息的群成员信息 |
| isPrivateChat | boolean | 是否为私聊 |
| burnDuration | int | 阅后即焚时间 |
| hasReadTime | long | 已读的时间点 |
ConversationInfo
会话信息
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | String | 会话ID |
| conversationType | int | 会话类型 1:单聊 2:群聊 |
| userID | String | 用户ID |
| groupID | String | 群组ID |
| showName | String | 会话显示的名称 |
| faceURL | String | 头像URL |
| recvMsgOpt | int | 消息接收方式 |
| unreadCount | int | 未读数 |
| groupAtType | int | @类型 |
| latestMsgSendTime | int | 最近消息的发送时间 |
| draftText | String | 草稿内容 |
| draftTextTime | int | 生成草稿的时间 |
| isPinned | boolean | 是否为置顶状态 |
| isPrivateChat | boolean | 是否开启了阅后即焚 |
| burnDuration | int | 阅后即焚的时长 |
| isNotInGroup | boolean | 是否还在组内，true: 已不在群内 |
| attachedInfo | String | 附加信息 |
| latestMsg | String | 最近的一条消息json字符串 |
| ex | String | 应用层扩展内容 |
CustomElem
自定义消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| data | String | 文本内容，json字符串 |
| extension | String | 扩展内容，json字符串，可为空 |
FaceElem
表情消息
| 参数 | 类型 | 说明 |
|---|---|---|
| index | int | 表情的下标位置，发送端对接收端自定义内嵌的表情包 |
| data | String | 其他表情，如URL表情直接返回URL |
FileElem
文件消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| filePath | String | 文件本地路径 |
| uuID | String | 唯一ID，可为空 |
| sourceUrl | String | 图片地址 |
| fileName | String | 文件名称 |
| fileSize | long | 文件大小 |
FriendInfo
好友申请信息
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | String | 好友id |
| nickname | String | 好友昵称 |
| faceURL | String | 好友头像 |
| gender | int | 发起者性别 |
| phoneNumber | String | 手机号 |
| birth | long | 出生日期 |
| String | 邮箱 | |
| remark | String | 好友备注名 |
| ex | String | 应用层扩展内容 |
| createTime | long | 创建时间 |
| addSource | int | 添加方式 |
| operatorUserID | String | 操作者id |
FriendReqInfo
好友申请信息
| 参数 | 类型 | 说明 |
|---|---|---|
| fromUserID | String | 发起者userID |
| fromNickname | String | 发起者昵称 |
| fromFaceURL | String | 发起者头像URL |
| fromGender | int | 发起者性别 |
| toUserID | String | 被添加者userID |
| toNickname | String | 被添加者昵称 |
| toFaceURL | String | 被添加者头像URL |
| toGender | int | 被添加者性别 |
| handleResult | int | 申请的处理结果 |
| reqMsg | String | 申请添加好友时的申请内容 |
| createTime | int | 发起申请的时间 |
| handlerUserID | String | 处理人的userID |
| handleMsg | String | 处理好友申请时的审批消息 |
| handleTime | int | 处理时间 |
| ex | String | 应用层扩展内容 |
PublicUserInfo
用户公开信息，主要是基本信息，不包括手机等其它隐私字段
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | String | 用户ID |
| nickname | String | 用户昵称 |
| faceURL | String | 头像URL |
| gender | int | 性别 |
BlacklistInfo
黑名单信息，黑名单用户基本信息，注意黑名单是双向关系。
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | String | 用户ID |
| nickname | String | 用户昵称 |
| faceURL | String | 头像URL |
| gender | int | 性别 |
| createTime | int | 拉黑时间 |
| addSource | int | 拉黑方式 |
| operatorUserID | String | 操作拉黑的uesrID |
| attachedInfo | String | 暂未实现 |
| ex | String | 应用层扩展内容 |
UserInfo
用户信息
| 参数 | 类型 | 说明 |
|---|---|---|
| globalRecvMsgOpt | int | 消息接收的方式 |
| publicInfo | PublicUserInfo | 用户公开信息 |
| friendInfo | FriendInfo | 好友信息 |
| blackInfo | BlacklistInfo | 黑名单信息 |
| userID | String | 用户ID |
| showName | String | 用户昵称 |
| faceURL | String | 用户头像 |
| gender | int | 性别 |
GrpReqInfo
申请入群信息
| 参数 | 类型 | 说明 |
|---|---|---|
| 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 | 处理结果 |
| reqMsg | String | 申请加群的申请内容 |
| handledMsg | String | 处理申请的审批内容 |
| reqTime | int | 申请进群的时间 |
| handleUserID | String | 处理进群的userID |
| handledTime | int | 处理近期申请的时间 |
| ex | String | 应用层扩展内容 |
| inviterUserID | String | 邀请进群userID |
| joinSource | int | 进群方式 |
GrpInfo
| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | String | 群组ID |
| createTime | int | 群创建的时间 |
| memberCount | int | 群成员数量 |
| status | int | 群状态 |
| creatorUserID | String | 创建者userID |
| ownerUserID | String | 所有者userID |
| needVerification | int | 进群验证方式 |
| lookMemberInfo | int | 是否允许查看其他群成员的信息 |
| applyMemberFriend | int | 是否可以添加群成员为好友 |
| notificationUpdateTime | int | 群公告更新的时间 |
| notificationUserID | String | 群公告发布者userID |
| groupName | String | 群名称 |
| notification | String | 群公告 |
| introduction | String | 群简介 |
| faceURL | String | 群头像URL |
| ex | String | 应用层扩展内容 |
GroupMembersInfo
群成员信息
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | String | 群成员ID |
| roleLevel | int | 群成员身份 |
| groupID | String | 群组ID |
| nickname | String | 群成员昵称 |
| faceURL | String | 群成员头像URL |
| joinTime | int | 群成员进群的时间 |
| joinSource | String | 群成员进群 |
| operatorUserID | String | 同意进群的userID |
| muteEndTime | long | 禁言结束时间 |
| inviterUserID | String | 邀请者userID |
| ex | String | 应用层扩展内容 |
LocationElem
定位消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| desc | String | 位置描述内容 |
| longitude | double | 经度 |
| latitude | double | 纬度 |
MergeElem
合并消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| title | String | 标题 |
| abstractList | List |
需要显示的前几条消息的摘要 |
| multiMessage | List<Message> | 选择合并的消息内容列表 |
AdvancedTextElem
高级消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| text | String | 消息内容 |
| messageEntityList | List |
暂未实现 |
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 | boolean | 是否展示角标 |
| operatorUserID | String | 发送者用户ID |
| ex | String | 应用层扩展内容 |
Message
消息结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| clientMsgID | String | 客户端消息ID |
| serverMsgID | String | 服务端消息ID |
| createTime | long | 创建消息的时间 |
| sendTime | long | 发送消息的时间 |
| sessionType | int | 会话类型 |
| sendID | String | 发送消息者ID |
| recvID | String | 接收消息者ID |
| handleMsg | String | 处理的消息内容 |
| msgFrom | int | 消息来源级别 |
| contentType | int | 消息类型 |
| platformID | int | 平台ID |
| senderNickname | String | 发送者昵称 |
| senderFaceUrl | String | 发送者头像URL |
| groupID | String | 群组ID |
| content | String | 消息内容 |
| seq | int | 消息的seq |
| isRead | String | 已读标识 |
| status | int | 消息发送的状态 |
| 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 | NotificationElem | 通知消息内容 |
| faceElem | FaceElem | 自定义表情内容 |
| attachedInfoElem | AttachedInfoElem | 附加消息内容 |
| advancedTextElem | AdvancedTextElem | 暂未实现 |
| typingElem | TypingElem | 正在输入消息内容 |
| isReact | boolean | 暂未实现 |
| isExternalExtensions | boolean | 暂未实现 |
NotificationElem
通知消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| detail | String | 通知内容详情 |
| defaultTips | String | 默认提示内容 |
PictureInfo
图片信息描述
| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | String | 唯一ID，可为空 |
| type | String | 图片类型, 可为空 |
| size | long | 图片大小 |
| 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 |
信息列表 |
SearchResult
查找本地消息结果
| 参数 | 类型 | 说明 |
|---|---|---|
| totalCount | int | 总消息数量 |
| searchResultItems | List<SearchResultItem> | 搜索结果列表 |
| findResultItems | List<SearchResultItem> | 查找结果列表 |
SoundElem
语音消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | String | 唯一ID |
| soundPath | String | 本地路径 |
| sourceUrl | String | 音频文件URL |
| dataSize | long | 音频文件大小 |
| duration | long | 音频文件时长 |
VideoElem
| 参数 | 类型 | 说明 |
|---|---|---|
| videoPath | String | 视频本地路径 |
| videoUUID | String | 视频ID |
| videoUrl | String | 视频URL |
| videoType | String | 视频类型 |
| videoSize | long | 视频大小 |
| duration | long | 视频时长 |
| snapshotPath | String | 视频快照本地路径 |
| snapshotUUID | String | 视频快照ID |
| snapshotSize | long | 视频快照大小 |
| snapshotUrl | String | 视频快照URL |
| snapshotWidth | int | 视频快照宽度 |
| snapshotHeight | int | 视频快照高度 |
SearchResultItem
查找本地消息结果的item
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | String | 会话ID |
| messageCount | int | 消息数量 |
| showName | String | 展示的昵称 |
| faceURL | String | 头像URL |
| messageList | List<Message> | 消息列表 |