Message
功能介绍
消息属性
腾讯云 IM 消息按照消息存储策略，可以分为两种消息：在线消息、非在线消息。
在线消息是指只有当用户在线时才能接收到，离线后不会通过离线推送下发给用户。非在线消息是指无论用户是否在线，都能收到的消息。
在线消息会实时下发，不会存储在服务端。SDK 也不会存储在线消息。所以换设备或卸载后重新安装 App 拉取历史消息都不能拉到此类消息。
直播群所有的消息都属于在线消息。
全员推送的消息都属于在线消息。
非在线消息会被 SDK 和服务端存储。漫游服务器默认存储 7 天的消息。如果您希望存储超过 7 天，需要购买增值服务。服务内容和计费请查看 增值服务资费。
换设备或卸载后重新安装 App 拉取历史消息可以拉到此类消息。例如所有类型的普通消息。
参数介绍
message_elem_array
- 参数类型 : List< Elem >
- 参数描述 : 读写(必填), 消息内元素列表
message_conv_id
- 参数类型 : string
- 参数描述 : 读写(选填), 消息所属会话ID
message_conv_type
- 参数类型 : TIMConvType?
- 参数描述 : 读写(选填), 消息所属会话类型
message_sender
- 参数类型 : string
- 参数描述 : 读写(选填), 消息的发送者
message_priority
- 参数类型 : TIMMsgPriority?
- 参数描述 : 读写(选填), 消息优先级
message_client_time
- 参数类型 : ulong?
- 参数描述 : 读写(选填), 客户端时间
message_server_time
- 参数类型 : ulong?
- 参数描述 : 读写(选填), 服务端时间
message_is_from_self
- 参数类型 : bool?
- 参数描述 : 读写(选填), 消息是否来自自己
message_platform
- 参数类型 : TIMPlatform?
- 参数描述 : 读写(选填), 发送消息的平台
message_is_read
- 参数类型 : bool?
- 参数描述 : 读写(选填), 消息是否已读
message_is_online_msg
- 参数类型 : bool?
- 参数描述 : 读写(选填), 消息是否是在线消息，false表示普通消息,true表示阅后即焚消息，默认为false
message_is_peer_read
- 参数类型 : bool?
- 参数描述 : 只读, 消息是否被会话对方已读
message_receipt_peer_read
- 参数类型 : bool?
- 参数描述 : 只读, 对方是否已读（会话维度，已读的条件：msg_time <= 对端标记会话已读的时间），该字段为 true 的条件是消息 timestamp <= 对端标记会话已读的时间
message_need_read_receipt
- 参数类型 : bool?
- 参数描述 : 读写(选填), 消息是否需要已读回执（6.1 以上版本有效，需要您购买旗舰版套餐），群消息在使用该功能之前，需要先到 IM 控制台设置已读回执支持的群类型
message_support_message_extension
- 参数类型 : bool?
- 参数描述 : 读写(选填), 是否支持消息扩展
message_has_sent_receipt
- 参数类型 : bool?
- 参数描述 : 只读, 是否已经发送了已读回执（只有Group 消息有效）
message_group_receipt_read_count
- 参数类型 : int?
- 参数描述 : 只读, 注意：这个字段是内部字段，不推荐使用，推荐调用 TIMMsgGetMessageReadReceipts 获取群消息已读回执
message_group_receipt_unread_count
- 参数类型 : int?
- 参数描述 : 只读, 注意：这个字段是内部字段，不推荐使用，推荐调用 TIMMsgGetMessageReadReceipts 获取群消息已读回执
message_version
- 参数类型 : ulong?
- 参数描述 : 只读，注意：这个字段是内部字段，不推荐使用
message_status
- 参数类型 : TIMMsgStatus?
- 参数描述 : 读写(选填), 消息当前状态
message_unique_id
- 参数类型 : ulong
- 参数描述 : 只读, 消息的唯一标识，推荐使用 kTIMMsgMsgId
message_msg_id
- 参数类型 : string
- 参数描述 : 只读, 消息的唯一标识
message_rand
- 参数类型 : ulong
- 参数描述 : 只读, 消息的随机码
message_seq
- 参数类型 : ulong
- 参数描述 : 只读, 消息序列
message_custom_int
- 参数类型 : int?
- 参数描述 : 读写(选填), 自定义整数值字段（本地保存，不会发送到对端，程序卸载重装后失效）
message_custom_str
- 参数类型 : string
- 参数描述 : 读写(选填), 自定义数据字段（本地保存，不会发送到对端，程序卸载重装后失效）
message_cloud_custom_str
- 参数类型 : string
- 参数描述 : 读写(选填), 消息自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）
message_is_excluded_from_unread_count
- 参数类型 : bool?
- 参数描述 : 读写(选填),消息是否不计入未读计数：默认为 NO，表明需要计入未读计数，设置为 YES，表明不需要计入未读计数
message_is_forward_message
- 参数类型 : bool?
- 参数描述 : 读写(选填),是否是转发消息
message_group_at_user_array
- 参数类型 : List< string >
- 参数描述 : 读写(选填), 群消息中被 @ 的用户 UserID 列表（即该消息都 @ 了哪些人），如果需要 @ALL ，请传入 kImSDK_MesssageAtALL 字段
message_sender_profile
- 参数类型 : UserProfile
- 参数描述 : 读写(选填), 消息的发送者的用户资料
message_sender_group_member_info
- 参数类型 : GroupMemberInfo
- 参数描述 : 读写(选填), 消息发送者在群里面的信息，只有在群会话有效。目前仅能获取字段 kTIMGroupMemberInfoIdentifier、kTIMGroupMemberInfoNameCard 其他的字段建议通过 TIMGroupGetMemberInfoList 接口获取
message_target_group_member_array
- 参数类型 : List< string >
- 参数描述 : 只写(选填), 指定群消息接收成员（定向消息）；不支持群 @ 消息设置，不支持社群（Community）和直播群（AVChatRoom）消息设置；该字段设置后，消息会不计入会话未读数。
message_offlie_push_config
- 参数类型 : OfflinePushConfig
- 参数描述 : 读写(选填), 消息的离线推送设置
message_excluded_from_last_message
- 参数类型 : bool
- 参数描述 : 读写 是否作为会话的 lasgMessage，true - 不作为，false - 作为