TIMConversationManagerJsonKey

一. 会话 API 参数相关的 Json Key 定义

1.1 Draft (草稿信息)

JSON 键	值类型	属 性	含 义
kTIMDraftMsg	object Message	只读	草稿内的消息
kTIMDraftUserDefine	string	只读	用户自定义数据
kTIMDraftEditTime	uint	只读	上次设置草稿时的 UTC 时间戳

1.2 GroupAtInfo (群 @ 信息)

JSON 键	值类型	属 性	含 义
kTIMGroupAtInfoSeq	uint64	只读	@ 消息序列号, 即带有 “ @ 我” 或者 “ @ 所有人” 标记的消息的序列号
kTIMGroupAtInfoAtType	uint TIMGroupAtType	只读	@ 提醒类型, 分成 “ @ 我” 、“ @ 所有人” 以及 “ @ 我并 @ 所有人” 三类

1.3 ConvInfo (会话信息)

JSON 键	值类型	属 性	含 义
kTIMConvId	string	只读	会话 ID
kTIMConvType	uint TIMConvType	只读	会话类型
kTIMConvFaceUrl	string	只读	会话展示头像 (群组: 群头像; C2C: 对方头像)
kTIMConvUnReadNum	uint64	只读	会话未读计数
kTIMConvActiveTime	uint64	只读	会话的激活时间
kTIMConvIsHasLastMsg	bool	只读	会话是否有最后一条消息
kTIMConvLastMsg	object Message	只读	会话最后一条消息
kTIMConvIsHasDraft	bool	只读	会话是否有草稿
kTIMConvDraft	object Draft	只读(选填)	会话草稿
kTIMConvRecvOpt	uint TIMReceiveMessageOpt	只读(选填)	消息接收选项
kTIMConvGroupType	uint TIMGroupType	只读(选填)	群组类型, 仅当会话类型为群聊时有效
kTIMConvGroupAtInfoArray	array GroupAtInfo	只读(选填)	群会话 @ 信息列表, 用于展示 “有人 @ 我” 或 “ @ 所有人” 这两种提醒状态
kTIMConvIsPinned	bool	只读	是否置顶
kTIMConvShowName	string	只读	获取会话展示名称, 其展示优先级如下: 1 、群组, 群名称 -> 群 ID; C2C; 2 、对方好友备注 -> 对方昵称 -> 对方的 userID
kTIMConvMarkArray	array uint64	只读	会话标记列表, 取值详见 @TIMConversationMarkType (从 6.5 版本开始支持)
kTIMConvCustomData	string	只读	会话自定义数据 (从 6.5 版本开始支持)
kTIMConvConversationGroupArray	array string	只读	会话所属分组列表 (从 6.5 版本开始支持)
kTIMConvC2CReadTimestamp	uint64	只读	最新已读消息的 UTC 时间戳, 仅对单聊会话生效 (从 7.1 版本开始支持)
kTIMConvGroupReadSequence	uint64	只读	群消息已读 Sequence (从 7.1 版本开始支持)

1.4 TIMConversationListFilter (获取会话列表高级接口的 filter)

JSON 键	值类型	属 性	含 义
kTIMConversationListFilterConvType	uint TIMConvType	只写	会话类型
kTIMConversationListFilterConversationGroup	string	只写	会话分组名称 (不设置表示不过滤此项, 设置为 "" 代表过滤不属于任何分组的会话)
kTIMConversationListFilterMarkType	uint TIMConversationMarkType	只写	会话标记类型 (不设置表示不过滤此项, 设置为 0 代表过滤不含任何标记的会话)
kTIMConversationListFilterHasUnreadCount	bool	只写	会话是否含有未读数 (不设置表示不过滤此项, 设置为 true 代表过滤含未读数的会话; 设置为 false 代表过滤不含未读数的会话)
kTIMConversationListFilterHasGroupAtInfo	bool	只写	会话是否含有群 @ 信息 (不设置表示不过滤此项, 设置为 true 代表过滤含群 @ 消息的会话; 设置为 false 代表过滤不含群 @ 消息的会话)

1.5 TIMConversationListResult (获取会话列表的结果)

JSON 键	值类型	属 性	含 义
TIMConversationListResultConvList	array ConvInfo	只读	会话列表
TIMConversationListResultNextSeq	uint64	只读	分页拉取的游标
TIMConversationListResultIsFinished	bool	只读	分页拉取是否结束

1.6 GetConversationListParam (获取指定的会话列表)

JSON 键	值类型	属 性	含 义
kTIMGetConversationListParamConvId	string	只写	会话 ID
kTIMGetConversationListParamConvType	uint TIMConvType	只写	会话类型

1.7 GetTotalUnreadNumberResult (获取会话未读消息个数)

JSON 键	值类型	属 性	含 义
kTIMConvGetTotalUnreadMessageCountResultUnreadCount	int	只读	会话未读数

1.8 TIMConversationOperationResult (会话操作结果)

JSON 键	值类型	属 性	含 义
kTIMConversationOperationResultConversationID	string	只读	会话 ID
kTIMConversationOperationResultResultCode	int	只读	返回码
kTIMConversationOperationResultResultInfo	string	只读	返回信息