类型定义
CRIMAdvancedMsg
获取历史消息记录返回结果| 参数 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码 |
| errMsg | string | 错误信息 |
| lastMinSeq | int | 用于下一次请求参数 |
| isEnd | boolean | 是否拉取到最后一条消息 |
| messageList | list<CRIMMessage> | 消息列表 |
CRIMNotDisturbInfo
会话免打扰状态| 参数 | 类型 | 说明 |
|---|---|---|
| conversationId | string | 会话id |
| result | int | 免打扰状态0:正常; 1:屏蔽消息; 2:接收消息但不提示; |
CRIMAtInfo
at信息结构体| 参数 | 类型 | 说明 |
|---|---|---|
| atUserID | string | at成员的ID |
| groupNickname | string | at成员的群昵称 |
CRIMReadReceiptInfo
消息已读回执| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 已读用户ID,仅单聊时有效 |
| groupID | string | 已读群聊ID,仅群聊时有效 |
| msgIDList | list |
已读消息ID列表 |
| readTime | int64_t | 接收者阅读消息的时间点 |
| msgFrom | CRIMMsgLevel | 消息来源 |
| contentType | CRIMMsgType | 消息类型 |
| sessionType | CRIMConversationType | 会话类型 |
CRIMAtElem
at文本元素| 参数 | 类型 | 说明 |
|---|---|---|
| text | string | 消息内容 |
| atUserList | list |
被@的用户ID列表 |
| atUsersInfo | list<CRIMAtInfo> | 被@的用户信息列表 |
CRIMGroupHasReadInfo
群消息已读用户| 参数 | 类型 | 说明 |
|---|---|---|
| hasReadUserIDList | list |
已读的用户ID列表 |
| hasReadCount | int | 已读总数 |
| groupMemberCount | int | 当时发送此条消息的群人数 |
CRIMAttachedInfoElem
附加消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| groupHasReadInfo | CRIMGroupHasReadInfo | 已读消息的群成员信息 |
| isPrivateChat | boolean | 是否为阅后即焚消息 |
| burnDuration | int | 阅后即焚时间 |
| hasReadTime | int64_t | 已读的时间点 |
CRIMConversationInfo
会话信息| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | string | 会话ID |
| conversationType | CRIMConversationType | 会话类型 |
| userID | string | 用户ID |
| groupID | string | 群组ID |
| showName | string | 会话显示的名称 |
| faceURL | string | 头像URL |
| recvMsgOpt | CRIMReceiveMsgOpt | 消息接收方式 |
| unreadCount | int | 未读数 |
| groupAtType | CRIMGroupAtType | @类型 |
| latestMsgSendTime | int | 最近消息的发送时间 |
| draftText | string | 草稿内容 |
| draftTextTime | int | 生成草稿的时间 |
| isPinned | boolean | 是否为置顶状态 |
| isPrivateChat | boolean | 是否开启了阅后即焚 |
| burnDuration | int | 阅后即焚的时长 |
| isNotInGroup | boolean | 是否还在组内,true: 已不在群内 |
| attachedInfo | string | 附加信息 |
| latestMsg | string | 最近的一条消息json字符串 |
| ex | string | 应用层扩展内容 |
CRIMCustomElem
自定义消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| data | string | 文本内容 |
| description | string | 描述 |
| extension | string | 扩展内容,可为空 |
CRIMFaceElem
表情消息| 参数 | 类型 | 说明 |
|---|---|---|
| index | int | app内嵌表情包,根据index匹配显示表情图。非内嵌表情包时,此值填-1 |
| data | string | 其他表情信息 |
CRIMFileElem
文件消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| filePath | string | 文件本地路径 |
| uuID | string | 唯一ID,可为空 |
| sourceUrl | string | url地址 |
| fileName | string | 文件名称 |
| fileSize | int64_t | 文件大小 |
CRIMPublicUserInfo
用户公开信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| nickname | string | 用户昵称 |
| faceURL | string | 头像URL |
| ex | string | 应用层扩展内容 |
CRIMFriendInfo
好友信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 好友id |
| nickname | string | 好友昵称 |
| faceURL | string | 好友头像 |
| ex | string | 应用层扩展内容 |
| remark | string | 好友备注名 |
| createTime | int64_t | 创建时间 |
| addSource | int | 添加方式 |
| operatorUserID | string | 使双方成为好友的uesrID |
| attachedInfo | string | 附加信息 |
CRIMFriendReqInfo
好友申请信息| 参数 | 类型 | 说明 |
|---|---|---|
| fromUserID | string | 发起者userID |
| fromNickname | string | 发起者昵称 |
| fromFaceURL | string | 发起者头像URL |
| toUserID | string | 被添加者userID |
| toNickname | string | 被添加者昵称 |
| toFaceURL | string | 被添加者头像URL |
| reqMsg | string | 申请添加好友时的申请内容 |
| createTime | int | 发起申请的时间 |
| handlerUserID | string | 处理人的userID |
| handleMsg | string | 处理好友申请时的审批消息 |
| handleTime | int | 处理时间 |
| handleResult | CRIMReqStatus | 申请的处理结果 |
| ex | string | 应用层扩展内容 |
CRIMBlackListInfo
黑名单信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| nickname | string | 用户昵称 |
| faceURL | string | 头像URL |
| ex | string | 应用层扩展内容 |
| createTime | int | 拉黑时间 |
| addSource | int | 拉黑方式 |
| operatorUserID | string | 操作拉黑的uesrID |
| attachedInfo | string | 暂未实现 |
CRIMUserInfo
用户信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| nickname | string | 用户昵称 |
| faceURL | string | 头像URL |
| ex | string | 应用层扩展内容 |
| createTime | int64_t | 创建时间 |
| attachedInfo | string | 附加信息 |
| globalRecvMsgOpt | CRIMReceiveMsgOpt | 消息接收的方式 |
CRIMFullUserInfo
FullUserInfo: 整合了PublicUserInfo, FriendInfo和BlackInfo
getfriend时
如果是黑名单,则friendInfo和blackInfo会设置, 但publicInfo不设置getblack时,
如果是好友,则blackInfo和friendInfo会设置,但publicInfo不设置
| 参数 | 类型 | 说明 |
|---|---|---|
| publicInfo | CRIMPublicUserInfo | 用户公开信息 |
| friendInfo | CRIMFriendInfo | 好友信息 |
| blackInfo | CRIMBlackListInfo | 黑名单信息 |
CRIMUserStatusInfo
个人状态信息| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | string | 群组ID |
| platformIDs | list<CRIMPlatform> | 用户在线的平台ID列表 |
| status | int | 状态:0 表示离线,1 表示在线 |
CRIMSimpleResultInfo
通用结果信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| result | int | 结果。 checkFriend: result为1表示好友(并且不是黑名单) inviteUserToGrp、kickGrpMember: result为1表示成功 |
CRIMGrpReqInfo
申请入群信息| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | string | 群组ID |
| groupName | string | 群名称 |
| groupFaceURL | string | 群头像URL |
| userID | string | 进群申请者userID |
| nickname | string | 进群申请者昵称 |
| userFaceURL | string | 进群申请者头像URL |
| reqMsg | string | 申请加群的申请内容 |
| reqTime | int | 申请进群的时间 |
| handleResult | CRIMReqStatus | 处理结果 |
| handledMsg | string | 处理申请的审批内容 |
| handleUserID | string | 处理进群的userID |
| handledTime | int | 处理近期申请的时间 |
| ex | string | 应用层扩展内容 |
| inviterUserID | string | 邀请进群userID |
| joinSource | CRIMJoinType | 进群方式 |
CRIMGrpBaseInfo
群组基础信息| 参数 | 类型 | 说明 |
|---|---|---|
| groupType | CRIMGroupType | 群类型 |
| groupName | string | 群名 |
| faceURL | string | 群头像 |
| notification | string | 群公告 |
| introduction | string | 群简介 |
| ex | string | 扩展字段 |
CRIMGrpCreateInfo
群组创建信息| 参数 | 类型 | 说明 |
|---|---|---|
| groupInfo | CRIMGrpBaseInfo | 群信息 |
| memberUserIDs | list |
群成员的用户ID |
| adminUserIDs | list |
群管理员的用户ID |
| ownerUserID | string | 群主的用户ID |
CRIMGrpInfo
| 参数 | 类型 | 说明 |
|---|---|---|
| groupType | CRIMGroupType | 群类型 |
| groupName | string | 群名 |
| faceURL | string | 群头像 |
| notification | string | 群公告 |
| introduction | string | 群简介 |
| ex | string | 扩展字段 |
| groupID | string | 群组ID |
| createTime | int | 群创建的时间 |
| creatorUserID | string | 创建者userID |
| memberCount | int | 群成员数量 |
| status | CRIMGroupStatus | 群状态 |
| needVerification | CRIMGroupVerificationType | 进群验证方式 |
| lookMemberInfo | int | 是否允许查看其他群成员的信息。0:允许,1:不允许 |
| applyMemberFriend | int | 是否可以添加群成员为好友。0:允许,1:不允许 |
| notificationUpdateTime | int64_t | 群公告更新的时间 |
| notificationUserID | string | 群公告发布者userID |
CRIMGrpMemberInfo
群成员信息| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| nickname | string | 用户昵称 |
| faceURL | string | 头像URL |
| ex | string | 应用层扩展内容 |
| groupID | string | 群组ID |
| joinTime | int | 群成员进群的时间 |
| joinSource | CRIMJoinType | 群成员进群 |
| operatorUserID | string | 同意进群的userID |
| muteEndTime | int64_t | 禁言结束时间 |
| inviterUserID | string | 邀请者userID |
| roleLevel | CRIMGroupMemberRole | 群成员身份 |
CRIMLocationElem
定位消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| description | string | 位置描述内容 |
| longitude | double | 经度 |
| latitude | double | 纬度 |
CRIMMergeElem
合并消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| title | string | 标题 |
| abstractList | list |
需要显示的前几条消息的摘要 |
| multiMessage | list<CRIMMessage> | 选择合并的消息内容列表 |
CRIMTextElem
文本消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| content | string | 文本内容 |
CRIMCardElem
卡片消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户ID |
| nickname | string | 用户昵称 |
| faceURL | string | 头像URL |
| ex | string | 应用层扩展内容 |
CRIMTypingElem
正在输入信息| 参数 | 类型 | 说明 |
|---|---|---|
| msgTips | string | 提示的内容 |
CRIMOfflinePushInfo
离线推送消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| title | string | 推送标题 |
| desc | string | 推送描述 |
| iOSPushSound | string | 推送铃声文件的名称 |
| iOSBadgeCount | boolean | 是否展示角标 |
| ex | string | 应用层扩展内容 |
CRIMMessage
消息结构体| 参数 | 类型 | 说明 |
|---|---|---|
| clientMsgID | string | 客户端消息唯一ID,推荐使用 |
| serverMsgID | string | 服务端消息唯一ID,内部使用 |
| createTime | int64_t | 创建消息的时间 |
| sendTime | int64_t | 发送消息的时间 |
| sessionType | CRIMConversationType | 会话类型 |
| sendID | string | 发送消息者ID |
| recvID | string | 接收消息者ID |
| msgFrom | CRIMMsgLevel | 消息来源级别 |
| contentType | CRIMMsgType | 消息类型 |
| platformID | CRIMPlatform | 平台ID |
| senderNickname | string | 发送者昵称 |
| senderFaceUrl | string | 发送者头像URL |
| groupID | string | 群组ID |
| content | string | 消息内容 |
| seq | int | 消息的seq |
| isRead | string | 已读标识 |
| status | CRIMMsgStatus | 消息发送的状态 |
| attachedInfo | string | 附加信息 |
| ex | string | 扩展信息 |
| offlinePush | CRIMOfflinePushInfo | 离线消息推送内容 |
| textElem | CRIMTextElem | 文本内容 |
| cardElem | CRIMCardElem | 名片内容 |
| pictureElem | CRIMPictureElem | 图片消息内容 |
| soundElem | CRIMSoundElem | 语音消息内容 |
| videoElem | CRIMVideoElem | 视频 消息内容 |
| fileElem | CRIMFileElem | 文件消息内容 |
| mergeElem | CRIMMergeElem | 合并消息内容 |
| atTextElem | CRIMAtElem | @消息内容 |
| locationElem | CRIMLocationElem | 地理位置内容 |
| quoteElem | CRIMQuoteElem | 引用消息内容 |
| customElem | CRIMCustomElem | 自定义消息内容 |
| notificationElem | CRIMNotificationElem | 通知消息内容 |
| faceElem | CRIMFaceElem | 自定义表情内容 |
| attachedInfoElem | CRIMAttachedInfoElem | 附加消息内容 |
| typingElem | CRIMTypingElem | 正在输入消息内容 |
CRIMNotificationElem
通知消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| detail | string | 通知内容详情 |
| defaultTips | string | 默认提示内容 |
CRIMPictureInfo
图片信息描述| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | string | 唯一ID,可为空 |
| type | string | 图片类型, 可为空 |
| size | int64_t | 图片大小 |
| width | int | 图片宽度 |
| height | int | 图片高度 |
| url | string | 图片URL地址 |
CRIMPictureElem
图片消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| sourcePath | string | 本地路径 |
| sourcePicture | CRIMPictureInfo | 本地图片详情 |
| bigPicture | CRIMPictureInfo | 大图详情 |
| snapshotPicture | CRIMPictureInfo | 缩略图详情 |
CRIMQuoteElem
引用消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| text | string | 回复的消息内容 |
| quoteMessage | CRIMMessage | 被回复的消息 |
CRIMSoundElem
语音消息内容| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | string | 唯一ID |
| soundPath | string | 本地路径 |
| sourceUrl | string | 音频文件URL |
| dataSize | int64_t | 音频文件大小 |
| duration | int64_t | 音频文件时长 |
CRIMVideoElem
| 参数 | 类型 | 说明 |
|---|---|---|
| videoPath | string | 视频本地路径 |
| videoUUID | string | 视频ID |
| videoUrl | string | 视频URL |
| videoType | string | 视频类型 |
| videoSize | int64_t | 视频大小 |
| duration | int64_t | 视频时长 |
| snapshotPath | string | 视频快照本地路径 |
| snapshotUUID | string | 视频快照ID |
| snapshotSize | int64_t | 视频快照大小 |
| snapshotUrl | string | 视频快照URL |
| snapshotWidth | int | 视频快照宽度 |
| snapshotHeight | int | 视频快照高度 |
CRIMSearchResultItem
查找本地消息结果的item| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | string | 会话ID |
| messageCount | int | 消息数量 |
| showName | string | 展示的昵称 |
| faceURL | string | 头像URL |
| messageList | list<CRIMMessage> | 消息列表 |
CRIMRevokedInfo
撤回消息信息| 参数 | 类型 | 说明 |
|---|---|---|
| revokerID | string | 撤回者ID |
| revokerRole | CRIMGroupMemberRole | 撤回者群角色 |
| revokerNickname | string | 撤回者昵称 |
| clientMsgID | string | 消息id |
| revokeTime | int64_t | 撤回时间 |
| sourceMessageSendTime | int64_t | 消息发送时间 |
| sourceMessageSendID | string | 消息发送者 |
| sourceMessageSenderNickname | string | 消息发送者昵称 |
| sessionType | CRIMConversationType | 会话类型 |