Conversation

Conversation

会话对象,用于描述会话具有的属性,如类型、消息未读计数、最新消息等。

Properties:
Name Type Description
conversationID String

会话 ID。会话ID组成方式:

  • C2C${userID}(单聊)
  • GROUP${groupID}(群聊)
  • @TIM#SYSTEM(系统通知会话)
type String

会话类型,具体如下:

类型 含义
TIM.TYPES.CONV_C2C C2C(Client to Client, 端到端)会话
TIM.TYPES.CONV_GROUP GROUP(群组)会话
TIM.TYPES.CONV_SYSTEM SYSTEM(系统)会话。该会话只能接收来自系统的通知消息,不能发送消息。
subType String

群组会话的群组类型,具体如下:

类型 含义
TIM.TYPES.GRP_WORK 好友工作群
TIM.TYPES.GRP_PUBLIC 陌生人社交群
TIM.TYPES.GRP_MEETING 临时会议群
TIM.TYPES.GRP_AVCHATROOM 直播群
unreadCount Number

未读计数。TIM.TYPES.GRP_MEETING / TIM.TYPES.GRP_AVCHATROOM 类型的群组会话不记录未读计数,该字段值为0

lastMessage Object

会话最新的消息

Properties
Name Type Description
nick String

群会话最新消息的发送者的昵称,C2C 会话为 ''(v2.15.0起支持)

nameCard String

群会话最新消息的发送者的群名片,C2C 会话为 ''(v2.15.0起支持)

lastTime Number

当前会话最新消息的时间戳,单位:秒

lastSequence Number

当前会话的最新消息的 Sequence

fromAccount String

最新消息来源用户的 userID

isRevoked Boolean

会话最新的消息是否已被撤回,true 表示已撤回,默认值为 false

isPeerRead Boolean

对端是否已读 C2C 会话的最新消息,对端调用 setMessageRead 上报已读后 isPeerRead 为 true。默认 false(v2.20.0起支持)

messageForShow String

最新消息的内容,用于展示。可能值:文本消息内容、"[图片]"、"[语音]"、"[位置]"、"[表情]"、"[文件]"、"[自定义消息]"。
若该字段不满足您的需求,您可以使用 payload 来自定义渲染。

type String

消息类型,具体如下:

类型 含义
TIM.TYPES.MSG_TEXT 文本消息
TIM.TYPES.MSG_IMAGE 图片消息
TIM.TYPES.MSG_SOUND 音频消息(已废弃,请使用 TIM.TYPES.MSG_AUDIO )
TIM.TYPES.MSG_AUDIO 音频消息
TIM.TYPES.MSG_VIDEO 视频消息
TIM.TYPES.MSG_FILE 文件消息
TIM.TYPES.MSG_LOCATION 地理位置消息(v2.15.0起支持)
TIM.TYPES.MSG_CUSTOM 自定义消息
TIM.TYPES.MSG_GRP_TIP 群提示消息
TIM.TYPES.MSG_GRP_SYS_NOTICE 群系统通知消息
payload Object

消息的内容,具体如下:

groupProfile Group

群会话的群组资料

userProfile Profile

C2C会话的用户资料

groupAtInfoList Array.<GroupAtInfo>

群会话的 at 信息列表,接入侧可根据此信息在会话列表展示【有人@我】【@所有人】等效果。GroupAtInfo - 群 at 信息结构,v2.9.0 起支持。

remark String

好友备注,只有C2C会话且对端是我的好友,且我设置过此好友的备注才有值(v2.13.0起支持)

isPinned Boolean

会话是否置顶(v2.14.0起支持)

messageRemindType String

消息提醒类型(v2.16.0起支持),具体如下:

  • TIM.TYPES.MSG_REMIND_ACPT_AND_NOTE 在线正常接收消息,离线时会有厂商的离线推送通知(Web 和小程序端无离线推送)
  • TIM.TYPES.MSG_REMIND_DISCARD 在线和离线都拒收消息
  • TIM.TYPES.MSG_REMIND_ACPT_NOT_NOTE 在线正常接收消息,离线不会有推送通知(消息免打扰)
markList Array

会话标记列表(v2.22.0起支持),具体如下:

  • TIM.TYPES.CONV_MARK_TYPE_STAR 会话标星
  • TIM.TYPES.CONV_MARK_TYPE_UNREAD 会话标记未读(重要会话)
  • TIM.TYPES.CONV_MARK_TYPE_FOLD 会话折叠
  • TIM.TYPES.CONV_MARK_TYPE_HIDE 会话隐藏
customData String

会话自定义数据(v2.22.0起支持)

conversationGroupList Array

会话所属分组列表(v2.22.0起支持)

Type Definitions

GroupAtInfo

Properties:
Name Type Description
groupID String

群 ID

messageSequence Number

带 at 信息的消息的 sequence

atTypeArray Array.<Number>

at 类型数组,群会话 at 枚举值如下:

  • TIM.TYPES.CONV_AT_ME 有人 at 我
  • TIM.TYPES.CONV_AT_ALL at 群里所有人
  • TIM.TYPES.CONV_AT_ALL_AT_ME at 群里所有人并且单独 at 我

群 at 信息结构