new IMMessage()
IM 消息
- 'in'表示此消息是收到的消息
- 'out'表示此消息是发出的消息
'sending'
发送中'success'
发送成功'fail'
发送失败- 推荐使用
JSON
格式构建, 非JSON
格式的话, Web端会正常接收, 但是会被其它端丢弃 - 推荐使用
JSON
格式构建, 非JSON
格式的话, Web端会正常接收, 但是会被其它端丢弃
Properties:
Name | Type | Argument | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scene |
String | ||||||||||||||||||
from |
String | 消息发送方, 帐号 |
|||||||||||||||||
fromNick |
String | 消息发送方的昵称 |
|||||||||||||||||
fromClientType |
String | 发送方的 |
|||||||||||||||||
fromDeviceId |
String | 发送端设备id |
|||||||||||||||||
to |
String | 消息接收方, 帐号或群id |
|||||||||||||||||
time |
Number | 时间戳 |
|||||||||||||||||
userUpdateTime |
Number | 发送方信息更新时间 |
|||||||||||||||||
type |
String | ||||||||||||||||||
sessionId |
String | 消息所属的 |
|||||||||||||||||
target |
String | 聊天对象, 账号或者群id |
|||||||||||||||||
flow |
String | 消息的流向 |
|||||||||||||||||
status |
String | 消息发送状态 |
|||||||||||||||||
text |
String |
<optional> |
文本消息的文本内容, 请参考 |
||||||||||||||||
file |
Object |
<optional> |
|||||||||||||||||
geo |
Object |
<optional> |
|||||||||||||||||
tip |
String |
<optional> |
提醒消息的内容, 请参考 |
||||||||||||||||
content |
String |
<optional> |
自定义消息的消息内容, 开发者可以自行扩展, 建议封装成JSON格式字符串, 请参考 |
||||||||||||||||
attach |
Object |
<optional> |
|||||||||||||||||
idClient |
String | SDK生成的消息id, 在发送消息之后会返回给开发者, 开发者可以在发送消息的结果回调里面根据这个ID来判断相应消息的发送状态, 到底是发送成功了还是发送失败了, 然后根据此状态来更新页面的UI。如果发送失败, 那么可以重新发送此消息 |
|||||||||||||||||
idServer |
String |
<optional> |
服务器用于区分消息用的ID, 用于 |
||||||||||||||||
isMuted |
Boolean | 该消息在接收方是否应该被静音 |
|||||||||||||||||
resend |
Boolean | 是否是重发的消息 |
|||||||||||||||||
custom |
String |
<optional> |
扩展字段 |
||||||||||||||||
pushContent |
String |
<optional> |
自定义推送文案 |
||||||||||||||||
pushPayload |
String |
<optional> |
自定义的推送属性 |
||||||||||||||||
apns |
Object |
<optional> |
特殊推送选项, 只在群会话中使用 Properties
|
||||||||||||||||
localCustom |
String |
<optional> |
本地自定义扩展字段 |
||||||||||||||||
isHistoryable |
Boolean | 是否存储云端历史 |
|||||||||||||||||
isRoamingable |
Boolean | 是否支持漫游 |
|||||||||||||||||
isSyncable |
Boolean | 是否支持发送者多端同步 |
|||||||||||||||||
cc |
Boolean | 是否支持抄送 |
|||||||||||||||||
isPushable |
Boolean | 是否需要推送 |
|||||||||||||||||
isOfflinable |
Boolean | 是否要存离线 |
|||||||||||||||||
isUnreadable |
Boolean | 是否计入消息未读数 |
|||||||||||||||||
isReplyMsg |
Boolean | 是否为应答消息(用于机器人等类似场景等应答消息内容) |
|||||||||||||||||
tempTeamMemberCount |
Integer | 群已读消息快照大小(即消息发送时的群人数-1) |
|||||||||||||||||
needPushNick |
Boolean | 是否需要推送昵称 |
|||||||||||||||||
isLocal |
Boolean | 是否是本地消息, 请查阅 |
Members
-
<static, readonly> attach :String
-
群通知消息
- 群通知消息是
消息
的一种, 请参考消息类型
, 某些群操作后所有群成员会收到一条相应的群通知消息 群通知消息有一个字段
attach
包含了额外的信息,attach
有一个字段type
来标识群通知消息的类型'updateTeam'
(更新群)更新群
后, 所有群成员
会收到一条类型为
的'updateTeam'
群通知消息
。此类群通知消息的from
字段的值为更新群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为被更新的群信息
。
'addTeamMembers'
(拉人入群)- 普通群,
拉人入群
后, 所有群成员
会收到一条类型为
的'addTeamMembers'
群通知消息
。此类群通知消息的from字段的值为拉人的人的帐号,
to字段的值为对应的群ID,
attach有一个字段
team的值为对应的[群对象](#群对象),
attach有一个字段
accounts的值为被拉的人的帐号列表,
attach有一个字段
members`的值为被拉的群成员列表。 - 被邀请的群成员在有人说话后才能看到该
群
, 而且会先收到一条类型为
的'addTeamMembers'
群通知消息
, 然后会收到其它群消息
。
- 普通群,
'removeTeamMembers'
(踢人出群)踢人出群
后, 所有群成员
会收到一条类型为
的'removeTeamMembers'
群通知消息
。此类群通知消息的from
字段的值为踢人的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段accounts
的值为被踢的人的帐号列表。
'acceptTeamInvite'
(接受入群邀请)'passTeamApply'
(通过入群申请)'addTeamManagers'
(添加群管理员)添加群管理员
后, 所有群成员
会收到一条类型为
的'addTeamManagers'
群通知消息
。此类群通知消息的from
字段的值为添加群管理员的人的帐号,to
字段的值为对应的群ID,attach
有一个字段accounts
的值为被加为管理员的帐号列表,attach
有一个字段members
的值为被加为管理员的群成员列表。
'removeTeamManagers'
(移除群管理员)。移除群管理员
后, 所有群成员
会收到一条类型为
的'removeTeamManagers'
群通知消息
。此类群通知消息的from
字段的值为移除群管理员的人的帐号,to
字段的值为对应的群ID,attach
有一个字段accounts
的值为被移除的管理员的帐号列表,attach
有一个字段members
的值为被移除管理员的群成员列表。
'leaveTeam'
(主动退群)主动退群
后, 所有群成员
会收到一条类型为
的'leaveTeam'
群通知消息
。此类群通知消息的from
字段的值为退群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
。
'dismissTeam'
(解散群)解散群
后, 所有群成员
会收到一条类型为
的'dismissTeam'
群通知消息
。此类群通知消息的from
字段为解散群的人的帐号,to
字段的值为被对应的群ID。
'transferTeam'
(转让群)转让群
后, 所有群成员
会收到一条类型为
的'transferTeam'
群通知消息
。此类群通知消息的from
字段的值为转让群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段account
的值为为新群主的帐号,attach
有一个字段members
的值为包含新旧群主的群成员列表。
'updateTeamMute'
(更新群成员禁言状态)更新群成员禁言状态
后, 所有群成员
会收到一条类型为
的'updateTeamMute'
群通知消息
。此类群通知消息的from
字段的值为操作方,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段account
的值为被禁言的帐号,attach
有一个字段members
的值为被禁言的群成员列表。
'updateSuperTeam'
(更新超大群)更新超大群
后, 所有超大群群成员
会收到一条类型为
的'updateSuperTeam'
群通知消息
。此类群通知消息的from
字段的值为更新群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为被更新的超大群信息
。
'addSuperTeamMembers'
(拉人入超大群)- 普通群,
拉人入超大群
后, 所有超大群群成员
会收到一条类型为
的'addSuperTeamMembers'
群通知消息
。此类群通知消息的from
字段的值为拉人的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的超大群对象
,attach
有一个字段accounts
的值为被拉的人的帐号列表,attach
有一个字段members
的值为被拉的群成员列表。 - 被邀请的群成员在有人说话后才能看到该
超大群
, 而且会先收到一条类型为
的'addSuperTeamMembers'
群通知消息
, 然后会收到其它群消息
。
- 普通群,
'removeSuperTeamMembers'
(踢人出超大群)踢人出超大群
后, 所有超大群群成员
会收到一条类型为
的'removeSuperTeamMembers'
群通知消息
。此类群通知消息的from
字段的值为踢人的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段accounts
的值为被踢的人的帐号列表。
'leaveSuperTeam'
(主动退出超大群)主动退群
后, 所有超大群群成员
会收到一条类型为
的'leaveSuperTeam'
群通知消息
。此类群通知消息的from
字段的值为退群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
。
'dismissSuperTeam'
(解散超大群)- 解散超大群后, 所有
超大群群成员
会收到一条类型为
的'dismissSuperTeam'
群通知消息
。此类群通知消息的from
字段为解散群的人的帐号,to
字段的值为被对应的群ID。
- 解散超大群后, 所有
'transferSuperTeam'
(转让超大群)- 调用服务端API转让群后, 所有
群成员
会收到一条类型为
的'transferSuperTeam'
群通知消息
。此类群通知消息的from
字段的值为转让群的人的帐号,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段account
的值为为新群主的帐号,attach
有一个字段members
的值为包含新旧群主的群成员列表。
- 调用服务端API转让群后, 所有
'addSuperTeamManagers'
(添加超大群管理员)- 添加群管理员后, 所有
群成员
会收到一条类型为
的'addSuperTeamManagers'
群通知消息
。此类群通知消息的from
字段的值为添加群管理员的人的帐号,to
字段的值为对应的群ID,attach
有一个字段accounts
的值为被加为管理员的帐号列表,attach
有一个字段members
的值为被加为管理员的群成员列表。
- 添加群管理员后, 所有
'removeSuperTeamManagers'
(移除超大群管理员)。- 移除群管理员后, 所有
群成员
会收到一条类型为
的'removeSuperTeamManagers'
群通知消息
。此类群通知消息的from
字段的值为移除群管理员的人的帐号,to
字段的值为对应的群ID,attach
有一个字段accounts
的值为被移除的管理员的帐号列表,attach
有一个字段members
的值为被移除管理员的群成员列表。
- 移除群管理员后, 所有
'updateSuperTeamMembersMute'
(更新超大群成员禁言状态)- 更新群成员禁言状态后, 所有
群成员
会收到一条类型为
的'updateSuperTeamMembersMute'
群通知消息
。此类群通知消息的from
字段的值为操作方,to
字段的值为对应的群ID,attach
有一个字段team
的值为对应的群对象
,attach
有一个字段account
的值为被禁言的帐号,attach
有一个字段members
的值为被禁言的群成员列表。
- 更新群成员禁言状态后, 所有
如果
attach
有account
或者accounts
字段, 那么attach
的字段users
包含这些账号对应的用户名片- 更新群昵称不会收到群通知消息, 所有其它在线的群成员会收到
初始化SDK
时传入的onupdateteammember
回调或onUpdateSuperTeamMember
回调, 请参考修改自己的超大群属性
、修改自己的群属性
和修改别人的群昵称
Type:
- String
- 群通知消息是
-
<static, readonly> scene :String
-
场景
'p2p'
(单人聊天)'team'
(群聊)'superTeam'
(超大群聊天)
Type:
- String
-
<static, readonly> type :String
-
消息类型
'text'
(文本)'image'
(图片)'audio'
(音频)'video'
(视频)'file'
(文件)'geo'
(地理位置)'custom'
(自定义消息)'tip'
(提醒消息)'robot'
(机器人消息)- 提醒消息用于会话内的状态提醒,如进入会话时出现的欢迎消息,或者会话命中敏感词后的提示消息等等.
'notification'
(群通知消息)- 某些群操作后所有群成员会收到一条相应的群通知消息, 详细介绍请参考
群通知消息的类型
- 此类消息不会计入未读数
- 某些群操作后所有群成员会收到一条相应的群通知消息, 详细介绍请参考
Type:
- String