MessageInfo
Function Introduction
info
Message structure. For specific types, refer to contentType and parse the corresponding Elem field.
Note
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
Message
| Field Name | Data Type | Description |
|---|---|---|
| clientMsgID | String | Unique client message ID, recommended use |
| serverMsgID | String | Unique server message ID, internal use |
| createTime | int | Creation time |
| sendTime | int | Sending time |
| sessionType | int | Session type |
| sendID | String | Sender's ID |
| recvID | String | Receiver's ID, not needed for group chat |
| msgFrom | int | Internal field |
| contentType | int | Message type |
| platformID | int | Platform number |
| senderNickname | String | Sender's nickname |
| senderFaceUrl | String | Sender's avatar |
| groupID | String | Group ID |
| content | String | Internal field |
| seq | int | Message's seq |
| isRead | bool | Is it read? |
| status | int | Message sending status |
| attachedInfo | String | Attached information |
| ex | String | Extended information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Image |
| soundElem | SoundElem | Voice |
| videoElem | VideoElem | Video |
| fileElem | FileElem | File |
| mergeElem | MergeElem | Merge |
| atElem | AtElem | @ information |
| locationElem | LocationElem | Location |
| quoteElem | QuoteElem | Quote |
| customElem | CustomElem | Custom |
| notificationElem | NotificationElem | Notification details |
| faceElem | FaceElem | Custom emoji |
| attachedInfoElem | AttachedInfoElem | Attached information |
| hasReadTime | int | Timestamp when read in individual chats |
| isReact | bool | Not in use |
| isExternalExtensions | bool | Not in use |
| textElem | TextElem | Text content |
| cardElem | CardElem | Card content |
| advancedTextElem | - | Not in use |
| typingElem | TypingElem | Currently typing details |
OIMMessageInfo
| Field Name | Data Type | Description |
|---|---|---|
| clientMsgID | NSString | Unique client message ID, recommended use |
| serverMsgID | NSString | Unique server message ID, internal use |
| createTime | NSInteger | Creation time |
| sendTime | NSInteger | Sending time |
| sessionType | OIMConversationType | Session type |
| sendID | NSString | Sender's ID |
| recvID | NSString | Receiver's ID, not needed for group chat |
| msgFrom | NSInteger | Internal field |
| contentType | OIMMessageContentType | Message type |
| platformID | NSInteger | Platform number |
| senderNickname | NSString | Sender's nickname |
| senderFaceUrl | NSString | Sender's avatar |
| groupID | NSString | Group ID |
| content | NSString | Internal field |
| seq | NSInteger | Message's seq |
| isRead | BOOL | Is it read? |
| status | OIMMessageStatus | Message sending status |
| attachedInfo | NSString | Attached information |
| ex | NSString | Extended information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Image |
| soundElem | SoundElem | Voice |
| videoElem | VideoElem | Video |
| fileElem | FileElem | File |
| mergeElem | MergeElem | Merge |
| atElem | AtElem | @ information |
| locationElem | LocationElem | Location |
| quoteElem | QuoteElem | Quote |
| customElem | CustomElem | Custom |
| notificationElem | NotificationElem | Notification details |
| faceElem | FaceElem | Custom emoji |
| attachedInfoElem | AttachedInfoElem | Attached information |
| textElem | TextElem |
Certainly, here's the translated content:
Message
| Field Name | Field Type | Description |
|---|---|---|
| clientMsgID | String | Unique client message ID, recommended for use |
| serverMsgID | String | Unique server message ID, for internal use |
| createTime | int | Creation time |
| sendTime | int | Sending time |
| sessionType | int | Conversation type ConversationType |
| sendID | String | Sender ID |
| recvID | String | Receiver ID, not needed for group chats |
| msgFrom | int | Internal field |
| contentType | int | Message type MessageType |
| platformID | int | Platform number |
| senderNickname | String | Sender's nickname |
| senderFaceUrl | String | Sender's avatar |
| groupID | String | Group ID |
| content | String | Internal field |
| seq | int | Message's seq |
| isRead | bool | Whether it's read |
| status | int | Message sending status MessageStatus |
| attachedInfo | String | Internal field |
| ex | String | Extension information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Picture |
| soundElem | SoundElem | Voice |
| videoElem | VideoElem | Video |
| fileElem | FileElem | File |
| mergeElem | MergeElem | Merge |
| atElem | AtElem | @ information |
| locationElem | LocationElem | Location |
| quoteElem | QuoteElem | Quote |
| customElem | CustomElem | Custom |
| notificationElem | NotificationElem | Notification details |
| faceElem | FaceElem | Custom emoji |
| attachedInfoElem | AttachedInfoElem | Additional information |
| hasReadTime | int | Timestamp when the private message was read |
| isReact | boolean | Not in use |
| isExternalExtensions | boolean | Not in use |
| textElem | TextElem | Text content |
| cardElem | CardElem | Business card content |
| advancedTextElem | - | Not in use |
| typingElem | TypingElem | Currently typing details |
| ext | String | Android extension information |
MessageItem
| Field Name | Data Type | Description |
|---|---|---|
| clientMsgID | string | Unique client message ID, recommended |
| serverMsgID | string | Unique server message ID, internal use |
| createTime | number | Creation time |
| sendTime | number | Sending time |
| sessionType | SessionType | Session type |
| sendID | string | Sender ID |
| recvID | string | Receiver ID, not needed for group chat |
| msgFrom | number | Internal field |
| contentType | MessageType | Message type |
| platformID | Platform | Platform number |
| senderNickname | string | Sender's nickname |
| senderFaceUrl | string | Sender's avatar |
| groupID | string | Group ID |
| content | string | Internal field |
| seq | number | Message's seq |
| isRead | boolean | Is it read |
| status | MessageStatus | Message sending status |
| attachedInfo | string | Internal field |
| ex | string | Extended information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Picture message details |
| soundElem | SoundElem | Voice message details |
| videoElem | VideoElem | Video message details |
| fileElem | FileElem | File message details |
| mergeElem | MergeElem | Merged message details |
| atTextElem | atTextElem | @ message details |
| locationElem | LocationElem | Location message details |
| quoteElem | QuoteElem | Quoted message details |
| customElem | CustomElem | Custom message details |
| notificationElem | NotificationElem | Notification message details |
| faceElem | FaceElem | Custom emoji details |
| attachedInfoElem | AttachedInfoElem | Additional information details |
| textElem | TextElem | Text content details |
| cardElem | CardElem | Card content details |
| advancedTextElem | - | Not in use |
| typingElem | TypingElem | Typing details |
| hasReadTime | number | Read timestamp for individual chat |
| isReact | boolean | Not in use |
| isExternalExtensions | boolean | Not in use |
MessageItem
| Field Name | Data Type | Description |
|---|---|---|
| clientMsgID | string | Unique client message ID, recommended |
| serverMsgID | string | Unique server message ID, internal use |
| createTime | number | Creation time |
| sendTime | number | Sending time |
| sessionType | SessionType | Session type |
| sendID | string | Sender ID |
| recvID | string | Receiver ID, not needed for group chat |
| msgFrom | number | Internal field |
| contentType | MessageType | Message type |
| platformID | Platform | Platform number |
| senderNickname | string | Sender's nickname |
| senderFaceUrl | string | Sender's avatar |
| groupID | string | Group ID |
| content | string | Internal field |
| seq | number | Message's seq |
| isRead | boolean | Is it read |
| status | MessageStatus | Message sending status |
| attachedInfo | string | Internal field |
| ex | string | Extended information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Picture message details |
| soundElem | SoundElem | Voice message details |
| videoElem | VideoElem | Video message details |
| fileElem | FileElem | File message details |
| mergeElem | MergeElem | Merged message details |
| atTextElem | atTextElem | @ message details |
| locationElem | LocationElem | Location message details |
| quoteElem | QuoteElem | Quoted message details |
| customElem | CustomElem | Custom message details |
| notificationElem | NotificationElem | Notification message details |
| faceElem | FaceElem | Custom emoji details |
| attachedInfoElem | AttachedInfoElem | Additional information details |
| textElem | TextElem | Text content details |
| cardElem | CardElem | Card content details |
| advancedTextElem | - | Not in use |
| typingElem | TypingElem | Typing details |
| hasReadTime | number | Read timestamp for individual chat |
| isReact | boolean | Not in use |
| isExternalExtensions | boolean | Not in use |
MessageItem
| Field Name | Data Type | Description |
|---|---|---|
| clientMsgID | string | Unique client message ID, recommended |
| serverMsgID | string | Unique server message ID, internal use |
| createTime | number | Creation time |
| sendTime | number | Sending time |
| sessionType | SessionType | Session type |
| sendID | string | Sender ID |
| recvID | string | Receiver ID, not needed for group chat |
| msgFrom | number | Internal field |
| contentType | MessageType | Message type |
| platformID | Platform | Platform number |
| senderNickname | string | Sender's nickname |
| senderFaceUrl | string | Sender's avatar |
| groupID | string | Group ID |
| content | string | Internal field |
| seq | number | Message's seq |
| isRead | boolean | Is it read |
| status | MessageStatus | Message sending status |
| attachedInfo | string | Internal field |
| ex | string | Extended information |
| offlinePush | OfflinePushInfo | Offline push details |
| pictureElem | PictureElem | Picture message details |
| soundElem | SoundElem | Voice message details |
| videoElem | VideoElem | Video message details |
| fileElem | FileElem | File message details |
| mergeElem | MergeElem | Merged message details |
| atTextElem | atTextElem | @ message details |
| locationElem | LocationElem | Location message details |
| quoteElem | QuoteElem | Quoted message details |
| customElem | CustomElem | Custom message details |
| notificationElem | NotificationElem | Notification message details |
| faceElem | FaceElem | Custom emoji details |
| attachedInfoElem | AttachedInfoElem | Additional information details |
| textElem | TextElem | Text content details |
| cardElem | CardElem | Card content details |
| advancedTextElem | - | Not in use |
| typingElem | TypingElem | Typing details |
| hasReadTime | number | Read timestamp for individual chat |
| isReact | boolean | Not in use |
| isExternalExtensions | boolean | Not in use |
Message
| Field Name | Data Type | Description |
|---|---|---|
| ClientMsgID | string | Unique client message ID, recommended |
| ServerMsgID | string | Unique server message ID, internal use |
| CreateTime | number | Creation time |
| SendTime | number | Sending time |
| SessionType | SessionType | Session type |
| SendID | string | Sender ID |
| RecvID | string | Receiver ID, not needed for group chat |
| MsgFrom | number | Internal field |
| ContentType | MessageType | Message type |
| PlatformID | Platform | Platform number |
| SenderNickname | string | Sender's nickname |
| SenderFaceUrl | string | Sender's avatar |
| GroupID | string | Group ID |
| Content | string | Internal field |
| Seq | number | Message's seq |
| IsRead | boolean | Is it read |
| Status | MessageStatus | Message sending status |
| AttachedInfo | string | Internal field |
| Ex | string | Extended information |
| OfflinePush | OfflinePushInfo | Offline push details |
| PictureElem | PictureElem | Picture message details |
| SoundElem | SoundElem | Voice message details |
| VideoElem | VideoElem | Video message details |
| FileElem | FileElem | File message details |
| MergeElem | MergeElem | Merged message details |
| AtTextElem | atTextElem | @ message details |
| LocationElem | LocationElem | Location message details |
| QuoteElem | QuoteElem | Quoted message details |
| CustomElem | CustomElem | Custom message details |
| NotificationElem | NotificationElem | Notification message details |
| FaceElem | FaceElem | Custom emoji details |
| AttachedInfoElem | AttachedInfoElem | Additional information details |
| TextElem | TextElem | Text content details |
| CardElem | CardElem | Card content details |
| AdvancedTextElem | - | Not in use |
| TypingElem | TypingElem | Typing details |
| HasReadTime | number | Read timestamp for individual chat |
| IsReact | boolean | Not in use |
| IsExternalExtensions | boolean | Not in use |