Json_value_msg

Introduction

Message

IM messages can be classified by message storage policy into two types: online messages and non-online messages.

Online messages can be received only by online users and will not be pushed when they are offline. Non-online messages can be received by users whether they are online or not.

Online messages are delivered in real time and not stored on the server or in the SDK. Therefore, they cannot be pulled from historical messages after the device is changed or the application is uninstalled and reinstalled.

All messages in an audio-video group are online messages.

Messages pushed to all users are online messages.

Non-online messages are stored in the SDK and on the server. By default, they are stored on the roaming server for seven days. If you want a longer storage period, you need to purchase the value-added service. For more information on the service content and billing, see Pricing.

These messages, for example, all types of ordinary messages, can be pulled from historical messages after the device is changed or the application is uninstalled and reinstalled.

Parameter introduction

message_elem_array

Parameter type : [ ElemTextElem | ElemImageElem | ElemSoundElem | ElemCustomElem | ElemFileElem | ElemVideoElem | ElemMergerElem | ElemFaceElem | ElemLocationElem | ElemGroupReportElem | ElemGroupTipsElem | any ]
Parameter description : element list in the message

message_conv_id

Parameter type : string
Parameter description : onversation ID of the message

message_conv_type

Parameter type : number
Parameter description : TIMConvType conversation type of the message

message_sender

Parameter type : string
Parameter description : message sender

message_priority

Parameter type : number
Parameter description : message priority

message_client_time

Parameter type : number
Parameter description : message client time

message_server_time

Parameter type : number
Parameter description : message server time

message_is_from_self

Parameter type : boolean
Parameter description : message is from self

message_platform

Parameter type : TIMPlatform
Parameter description : message platform

message_is_read

Parameter type : boolean
Parameter description : message is read or not

message_is_online_msg

Parameter type : boolean
Parameter description : is online message or not. False means normal message, ture means dissolve after read

message_is_peer_read

Parameter type : boolean
Parameter description : message is read by peer or not

message_status

Parameter type : TIMMsgStatus
Parameter description : message status

message_unique_id

Parameter type : number
Parameter description : message unique ID, please use kTIMMsgMsgId instead

message_msg_id

Parameter type : string
Parameter description : message id

message_rand

Parameter type : number
Parameter description : message random

message_seq

Parameter type : number
Parameter description : message sequence

message_custom_int

Parameter type : number
Parameter description : message custom integer, (stored locally, won't be sent to peers, dismissed after unload the App)

message_custom_str

Parameter type : string
Parameter description : message custom string, (stored locally, won't be sent to peers, dismissed after unload the App)

message_cloud_custom_str

Parameter type : string
Parameter description : message custom string, (stored online, will be sent to peers, dismissed after unload the App)

message_is_excluded_from_unread_count

Parameter type : boolean
Parameter description : message is excluded from unread count or not: Default False.

message_group_at_user_array

Parameter type : string
Parameter description : group @ userID list, kImSDK_MessageAtALL means @ALL

message_is_forward_message

Parameter type : boolean
Parameter description : message is forward message or not

message_sender_profile

Parameter type : userProfile
Parameter description : message sender profile

message_sender_group_member_info

Parameter type : GroupMemberInfo
Parameter description : group message sender info, only for group message, only kTIMGroupMemberInfoIdentifier, kTIMGroupMemberInfoNameCard are available here, others can be retrieved by TIMGroupGetMemberInfoList.

message_support_message_extension

Parameter type : boolean
Parameter description : Whether message extension is supported

message_offline_push_config

Parameter type : OfflinePushConfig
Parameter description : message offline push config

message_need_read_receipt

Parameter type : boolean
Parameter description : Read & Write (Optional), message needs read receipt or not. Before activate it, please go to IM console and set the group for read receipt feature.

message_receipt_peer_read

Parameter type : boolean
Parameter description : Read only, message receipt is read by peer or not. It's true only when msg_time <= the time peer marked read receipt

message_is_broadcast_message

Parameter type : boolean
Parameter description : Whether message is broadcast message

message_has_sent_receipt

Parameter type : boolean
Parameter description : Read only, has sent receipt or not

message_group_receipt_read_count

Parameter type : number
Parameter description : Read only. Caveat: this is SDK internal field, please call TIMMsgGetMessageReadReceipts to get group message read receipts.

message_group_receipt_unread_count

Parameter type : number
Parameter description : Read only. Caveat: this is SDK internal field, please call TIMMsgGetMessageReadReceipts to get group message read receipts.

message_version

Parameter type : number
Parameter description : message version

message_excluded_from_last_message

Parameter type : boolean
Parameter description : Read & Write (Optional), message is excluded from the lastMessage

message_excluded_from_content_moderation

Parameter type : boolean
Parameter description : Whether the content moderation will be passed (including [Local moderation]), this field setting will only be effective after the [Local moderation] function is enabled. If set to true, it indicates that the content moderation will not be passed. If it is set to false, indicates that the content has been reviewed. [Local Audit] Please refer to Local Audit Function.

message_target_group_member_array

Parameter type : string[]
Parameter description : Read & Write (Optional), message target group member userID list, not support for group @ message, not support for Community and AVChatRoom. Once set, this message won't be counted in conversation unread count

message_revoker_user_id

Parameter type : string
Parameter description : User id of revoking this message