内容审核
添加敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
LocalAuditWord word = new LocalAuditWord();
+word.setFilterType(AuditFilterType.REPLACE);
+word.setWordType(AuditWordType.SENSITIVE_WORDS);
+word.setKeyword("caonima");
+word.setReplacedContent("****");
+AddLocalAuditKeywordsRequest request = AddLocalAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .localAuditWords(Collections.singletonList(word)).build();
+
+AddLocalAuditKeywordsResult result = client.audit.addLocalAuditKeywords(request);
+删除敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
DeleteLocalAuditKeywordsRequest request = new DeleteLocalAuditKeywordsRequest();
+request.setSdkAppId(1400594307);
+LocalAuditWord word = new LocalAuditWord();
+word.setId(1L);
+word.setReplacedContent("****");
+word.setKeyword("caonima");
+word.setWordType(AuditWordType.SENSITIVE_WORDS);
+word.setFilterType(AuditFilterType.REPLACE);
+request.setLocalAuditWords(Collections.singletonList(word));
+
+DeleteLocalAuditKeywordsResult result = client.audit.deleteLocalAuditKeywords(request);
+获取敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
GetLocalAuditKeywordsRequest request = GetLocalAuditKeywordsRequest.builder().keyword("caonima")
+ .filterType(AuditFilterType.REPLACE)
+ .limit(1).offset(0).sdkAppId(1400594307).build();
+
+GetLocalAuditKeywordsResult result = client.audit.getLocalAuditKeywords(request);
+主动审核接口（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，送审音视图文等相关内容，其中图文同步返回机审结果，音视频通过异步回调的形式返回机审结果。
使用示例：
ContentModerationRequest request = ContentModerationRequest.builder().content("122")
+ .contentType(AuditContentType.TEXT)
+ .auditName(AuditNameType.C2C)
+ .build();
+
+ContentModerationResult result = client.audit.contentModeration(request);
+主动批量审核接口（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，批量送审图文等相关内容，音视频审核请查看主动审核接口。
使用示例：
BatchContentModerationRequest request = new BatchContentModerationRequest();
+request.setAuditName(AuditNameType.GROUP);
+AuditContentItem item1 = new AuditContentItem();
+item1.setContent("f*ck uuu");
+item1.setContentId(323245334);
+item1.setContentType(AuditContentType.TEXT);
+AuditContentItem item2 = AuditContentItem.builder()
+ .contentId(435545)
+ .contentType(AuditContentType.TEXT)
+ .content("cnm").build();
+request.setContents(Arrays.asList(item1, item2));
+
+BatchContentModerationResult result = client.audit.batchContentModeration(request);
+获取词库列表（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
GetCloudAuditKeyWordsIdsRequest request = GetCloudAuditKeyWordsIdsRequest.builder()
+ .limit(1)
+ .offset(0)
+ .sdkAppId(1400594307)
+ .build();
+
+GetCloudAuditKeywordsIdsResult result = client.audit.getCloudAuditKeywordsIds(request);
+获取敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
GetCloudAuditKeyWordsRequest request = GetCloudAuditKeyWordsRequest.builder()
+ .libId("fd")
+ .limit(1)
+ .offset(0)
+ .sdkAppId(1400594307)
+ .build();
+
+GetCloudAuditKeywordsResult result = client.audit.getCloudAuditKeywords(request);
+添加敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 RESTA PI 接口，增删改查云端审核相关词库。
使用示例：
UserKeyword userKeyword = new UserKeyword();
+userKeyword.setContent("caonima");
+userKeyword.setLabel(ContentModerationLabel.COMPOSITE);
+AddCloudAuditKeywordsRequest request = AddCloudAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .libId("fd")
+ .userKeywords(Collections.singletonList(userKeyword))
+ .build();
+
+AddCloudAuditKeywordsResult result = client.audit.addCloudAuditKeywords(request);
+删除敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
DeleteCloudAuditKeywordsRequest request = DeleteCloudAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .libId("fd")
+ .keywords(Arrays.asList("caonima", "wtf")).build();
+
+DeleteCloudAuditKeywordsResult result = client.audit.deleteCloudAuditKeywords(request);
+获取 App 中的所有群组
App 管理员可以通过该接口获取 App 中所有群组的 ID。
说明
即时通信 IM 内置多种群组类型，详情请参见 群组系统。
使用示例：
GetAppIdGroupListRequest request = GetAppIdGroupListRequest.builder()
+ .limit(10)
+ .groupType(GroupType.PUBLIC)
+ .next(0)
+ .build();
+
+GetAppIdGroupListResult result = client.group.getAppIdGroupList(request);
+创建群组
App 管理员可以通过该接口创建群组。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，用户（包括群主）使用 AVChatroom（直播群）时必须操作 SDK 主动申请进群 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
CreateGroupRequest request = CreateGroupRequest.builder()
+ .type(GroupType.PUBLIC)
+ .name("TestGroup")
+ .ownerAccount("user1")
+ .groupId("MyFirstGroup")
+ .introduction("This is group Introduction")
+ .notification("This is group Notification")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .maxMemberCount(500)
+ .applyJoinOption(ApplyJoinOption.FREE_ACCESS)
+ .inviteJoinOption(InviteJoinOption.DISABLE_INVITE)
+ .build();
+
+CreateGroupResult result = client.group.createGroup(request);
+获取群详细资料
App 管理员可以根据群组 ID 获取群组的详细信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<String> groupIdList = Collections.singletonList("MyFirstGroup");
+GetGroupInfoRequest request = new GetGroupInfoRequest(groupIdList);
+
+GetGroupInfoResult result = client.group.getGroupInfo(request);
+获取群成员详细资料
App 管理员可以根据群组 ID 获取群组成员的资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持，使用 Next 字段分批获取 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
因 Community（社群）人数较多，分页获取方式改用 Next 分批方法。
使用示例：
GetGroupMemberInfoRequest request = GetGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .limit(100)
+ .offset(0)
+ .build();
+
+GetGroupMemberInfoResult result = client.group.getGroupMemberInfo(request);
+获取指定群成员详细资料
App 管理员可根据群组 ID 与群内指定成员 UserID 列表等参数获取指定群组成员的资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetSpecifiedGroupMemberInfoRequest request = GetSpecifiedGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberInfoFilter(Collections.singletonList("bingo"))
+ .build();
+
+GetSpecifiedGroupMemberInfoResult result = client.group.getSpecifiedGroupMemberInfo(request);
+修改群基础资料
App 管理员可以通过该接口修改指定群组的基础信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupBaseInfoRequest request = ModifyGroupBaseInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .name("groupName")
+ .introduction("my first group")
+ .notification("hello world!")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .maxMemberNum(500)
+ .applyJoinOption(ApplyJoinOption.NEED_PERMISSION)
+ .muteAllMember(MuteAllMember.OFF)
+ .build();
+
+ModifyGroupBaseInfoResult result = client.group.modifyGroupBaseInfo(request);
+增加群成员
App 管理员可以通过该接口向指定的群中添加新成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom(直播群)不支持增加群成员，对此类型群组进行操作时会返回 10007 错误。用户加入此类型群组的唯一方式是用户申请加群。
使用示例：
MemberRequestItem item = new MemberRequestItem("user2");
+List<MemberRequestItem> memberList = Collections.singletonList(item);
+AddGroupMemberRequest request = AddGroupMemberRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberList(memberList)
+ .silence(1)
+ .build();
+
+AddGroupMemberResult result = client.group.addGroupMember(request);
+删除群成员
App 管理员可以通过该接口删除群成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持删除群成员，对这种类型的群组进行操作时会返回 10004 错误。如果管理员希望达到删除群成员的效果，可以通过设置 批量禁言和取消禁言 的方式实现。
使用示例：
List<String> toDelAccount = Collections.singletonList("user2");
+DeleteGroupMemberRequest request = DeleteGroupMemberRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberToDelAccount(toDelAccount)
+ .build();
+
+DeleteGroupMemberResult result = client.group.deleteGroupMember(request);
+修改群成员资料
App 管理员可以通过该接口修改群成员资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不存储群成员资料，所以不能修改成员资料。只能修改管理员和群主的成员资料，修改普通成员资料时会返回 10007 错误。
使用示例：
ModifyGroupMemberInfoRequest request = ModifyGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount("doocs")
+ .nameCard("hello World!")
+ .build();
+
+ModifyGroupMemberInfoResult result = client.group.modifyGroupMemberInfo(request);
+解散群组
App 管理员通过该接口解散群。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
DestroyGroupRequest request = new DestroyGroupRequest("MyFirstGroup");
+
+DestroyGroupResult result = client.group.destroyGroup(request);
+获取用户所加入的群组
App 管理员可以通过本接口获取某一用户加入的群信息。默认不获取用户已加入但未激活好友工作群（Work）以及直播群（AVChatRoom）群信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群），但默认不返回已加入但未激活的此类型群信息 |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，但默认不返回此类型群信息。如果指定拉取 AVChatRoom 类型群信息，获得的群信息可能不完整，AVChatRoom 并不存储所有的群成员资料。 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetJoinedGroupListRequest request = new GetJoinedGroupListRequest("doocs");
+
+GetJoinGroupListResult result = client.group.getJoinGroupList(request);
+查询用户在群组中的身份
App 管理员可以通过该接口获取一批用户在群内的身份，即“成员角色”。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持该接口，对此类型群组进行操作将返回 10007 错误；但可以通过 获取群组成员详细资料 达到查询“成员角色”的效果。
使用示例：
List<String> userAccount = Collections.singletonList("doocs");
+GetRoleInGroupRequest request = GetRoleInGroupRequest.builder()
+ .groupId("MyFirstGroup")
+ .userAccount(userAccount)
+ .build();
+
+GetRoleInGroupResult result = client.group.getRoleInGroup(request);
+批量禁言和取消禁言
- App 管理员禁止指定群组中某些用户在一段时间内发言。
- App 管理员取消对某些用户的禁言。
- 被禁言用户退出群组之后再进入同一群组，禁言仍然有效。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
Private（即新版本中的 Work，好友工作群）类型不支持禁言。
使用示例：
List<String> membersAccount = Collections.singletonList("doocs");
+ForbidSendMsgRequest request = ForbidSendMsgRequest.builder()
+ .groupId("MyFirstGroup")
+ .membersAccount(membersAccount)
+ .muteTime(200L)
+ .build();
+
+ForbidSendMsgResult result = client.group.forbidSendMsg(request);
+获取被禁言群成员列表
App 管理员可以根据群组 ID 获取群组中被禁言的用户列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMutedAccountRequest request = new GetGroupMutedAccountRequest("MyFirstGroup");
+
+GetGroupMutedAccountResult result = client.group.getGroupMutedAccount(request);
+在群组中发送普通消息
App 管理员可以通过该接口在群组中发送普通消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("red packet");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendGroupMsgRequest request = SendGroupMsgRequest.builder()
+ .groupId("MyFirstGroup")
+ .random(1314)
+ .msgBody(msgBody)
+ .onlineOnlyFlag(OnlineOnlyFlag.YES)
+ .build();
+
+SendGroupMsgResult result = client.group.sendGroupMsg(request);
+在群组中发送系统通知
App 管理员可以通过该接口在群组中发送系统通知。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，仅支持面向全员 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<String> toMembersAccount = Collections.singletonList("doocs");
+SendGroupSystemNotificationRequest request = SendGroupSystemNotificationRequest.builder()
+ .groupId("MyFirstGroup")
+ .content("hello world")
+ .toMembersAccount(toMembersAccount)
+ .build();
+
+SendGroupSystemNotificationResult result = client.group.sendGroupSystemNotification(request);
+转让群主
- App 管理员可以通过该接口将群主身份转移给他人。
- 没有群主的群，App 管理员可以通过此接口指定他人作为群主。
- 新群主必须为群内成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持（见说明） |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持转让群主，对该类型的群组进行操作时会返回 10007 错误。
使用示例：
ChangeGroupOwnerRequest request = ChangeGroupOwnerRequest.builder()
+ .groupId("MyFirstGroup")
+ .newOwnerAccount("doocs")
+ .build();
+
+ChangeGroupOwnerResult result = client.group.changeGroupOwner(request);
+撤回群消息
App 管理员通过该接口撤回指定群组的消息，消息需要在漫游有效期以内。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<MsgSeqItem> msgSeqList = Collections.singletonList(new MsgSeqItem(0L));
+GroupMsgRecallRequest request = GroupMsgRecallRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeqList(msgSeqList)
+ .build();
+
+GroupMsgRecallResult result = client.group.groupMsgRecall(request);
+导入群基础资料
App 管理员可以通过该接口导入群组，不会触发回调、不会下发通知； 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群组数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持导入群基础资料，对此类型的群组进行操作时会返回 10007 错误；如果需要达到导入群组基础资料的效果，可以通过 创建群组 和 修改群基础资料 的方式实现。
使用示例：
ImportGroupRequest request = ImportGroupRequest.builder()
+ .type(GroupType.PUBLIC)
+ .name("groupName")
+ .build();
+
+ImportGroupResult result = client.group.importGroup(request);
+导入群消息
- 该 API 接口的作用是导入群组的消息，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群消息数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持导入群消息，对此类型的群组进行操作时会返回 10007 错误；因为此类型群组所适用的场景不支持查看入群前的历史消息，所以没有提供这一功能。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+GroupMsgItem item = GroupMsgItem.builder()
+ .fromAccount("doocs")
+ .sendTime(1628062005)
+ .msgBody(msgBody)
+ .build();
+List<GroupMsgItem> msgList = Collections.singletonList(item);
+ImportGroupMsgRequest request = ImportGroupMsgRequest.builder()
+ .groupId("newGroup")
+ .msgList(msgList)
+ .build();
+
+ImportGroupMsgResult result = client.group.importGroupMsg(request);
+导入群成员
- 该 API 接口的作用是导入群组成员，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群成员数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）所适用的场景一般不需要导入成员，因此不支持导入群成员功能，对此类型的群组进行操作时会返回 10007 错误。
使用示例：
MemberItem item = MemberItem.builder()
+ .memberAccount("doocs")
+ .joinTime(1628062005)
+ .role(MemberRole.ADMIN)
+ .unreadMsgNum(1)
+ .build();
+List<MemberItem> members = Collections.singletonList(item);
+ImportGroupMemberRequest request = ImportGroupMemberRequest.builder()
+ .groupId("groupName")
+ .memberList(members)
+ .build();
+
+ImportGroupMemberResult result = client.group.importGroupMember(request);
+设置成员未读消息计数
- App 管理员使用该接口设置群组成员未读消息数，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议设置群成员的未读消息计数。
说明
该文档仅限迁移用户使用，线上用户不能使用。
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
ChatRoom 和 AVChatroom（直播群）的客户端不支持未读消息计数，所以对这两种类型的群组成员设置未读消息计数是无效的（但是不会返回错误）。
使用示例：
SetUnreadMsgNumRequest result = SetUnreadMsgNumRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount("doocs")
+ .unreadMsgNum(1)
+ .build();
+
+SetUnreadMsgNumResult result = client.group.setUnreadMsgNum(request);
+删除指定用户发送的消息
该 API 接口的作用是撤回最近 1000 条消息中指定用户发送的消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
- AVChatRoom（直播群）不支持历史消息存储（此处撤回消息指撤回历史消息存储中的消息），对这此类型群组中的用户撤回消息是无效的（但是不会返回错误）。
- 该接口目前只支持静默撤回，在服务端对该消息打上撤回标记，并不会通知到客户端，只有拉漫游时才知道该消息被撤回。
使用示例：
DeleteGroupMsgBySenderRequest request = DeleteGroupMsgBySenderRequest.builder()
+ .groupId("MyFirstGroup")
+ .senderAccount("doocs")
+ .build();
+
+DeleteGroupMsgBySenderResult result = client.group.deleteGroupMsgBySender(request);
+拉取群历史消息
App 管理员可以通过该接口拉取群组的历史消息。
背景说明：
- 即时通信 IM 的群消息是按 Seq 排序的，按照 server 收到群消息的顺序分配 Seq，先发的群消息 Seq 小，后发的 Seq 大。
- 如果用户想拉取一个群的全量消息，首次拉取时不用填拉取 Seq，Server 会自动返回最新的消息，以后拉取时拉取 Seq 填上次返回的最小 Seq 减 1。
- 如果返回消息的 IsPlaceMsg 为 1，表示这个 Seq 的消息或者过期、或者存储失败、或者被删除了。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom(直播群) 不支持历史消息存储，所以不支持调用此接口。
使用示例：
GroupMsgGetSimpleRequest request = GroupMsgGetSimpleRequest.builder()
+ .groupId("MyFirstGroup")
+ .reqMsgNumber(1)
+ .reqMsgNumber(20)
+ .build();
+
+GroupMsgGetSimpleResult result = client.group.groupMsgGetSimple(request);
+获取直播群在线人数
App 管理员可以根据群组 ID 获取直播群在线人数。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
注意
- 在线人数总体更新粒度为 10s。
- 当群人数大于等于 300 或群内有 Web 端用户的时候，出现群成员上下线或者进退群的时候，由于当前 10s 周期内已经统计了用户在线状态的原因，会在下一个 10s 周期才会统计到剔除状态用户变更的在线人数，所以会出现调用接口 10s - 20s 才会更新的现象。
- 当群人数小于 300 人且群内没有 Web 端用户的时候，用户进退群会触发即时更新在线人数。
使用示例：
GetOnlineMemberNumRequest request = new GetOnlineMemberNumRequest("MyFirstAVChatRoom");
+
+GetOnlineMemberNumResult result = client.group.getOnlineMemberNum(request);
+获取直播群在线列表
App 管理员可以根据群组 ID 获取直播群在线列表。
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。 :::
注意
- 此功能需 旗舰版套餐，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
- 在线列表总体更新粒度为 10s。
- 当直播群中超过 1000 人时，接口仅返回最新进群并且在线的 1000 人。
- 当群人数大于等于 300 或群内有 Web 端用户的时候，出现群成员上下线或者进退群的时候，由于当前 10s 周期内已经统计了用户在线状态的原因，会在下一个 10s 周期才会统计到剔除状态用户变更的在线人数，所以会出现调用接口 10s - 20s 才会更新的现象。
- 当群人数小于 300 人且群内没有 Web 端用户的时候，用户进退群会触发即时更新在线人数。
使用示例：
GetMembersRequest request = GetMembersRequest.builder()
+ .groupId("MyFirstGroup")
+ .timestamp(0)
+ .build();
+
+GetMembersResult result = client.group.getMembers(request);
+设置直播群成员标记
App 管理员和群主可以对直播群成员设置不同的标记以区分不同类型的群成员。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该 API 将返回失败。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupUserInfoRequest request = new ModifyGroupUserInfoRequest();
+request.setCommandType(1);
+GroupMemberItem item = new GroupMemberItem();
+item.setMarks(Arrays.asList(1001, 1002));
+item.setMemberAccount("test1");
+request.setMemberList(Collections.singletonList(item));
+request.setGroupId("MyFirstGroup");
+
+ModifyGroupUserInfoResult result = client.group.modifyGroupUserInfo(request);
+获取群自定义属性
App 管理员可以通过该接口获取群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupAttrRequest request = new GetGroupAttrRequest("MyFirstGroup");
+
+GetGroupAttrResult result = client.group.getGroupAttr(request);
+修改群自定义属性
App 管理员可以通过该接口修改群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GroupAttr groupAttr = new GroupAttr();
+groupAttr.setKey("isOpen");
+groupAttr.setValue("yes");
+List<GroupAttr> groupAttrs = Collections.singletonList(groupAttr);
+ModifyGroupAttrRequest request = ModifyGroupAttrRequest.builder()
+ .groupId("MyFirstGroup")
+ .groupAttrs(groupAttrs)
+ .build();
+
+ModifyGroupAttrResult result = client.group.modifyGroupAttr(request);
+清空群自定义属性
App 管理员可以通过该接口清空群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ClearGroupAttrRequest request = new ClearGroupAttrRequest("MyFirstGroup");
+
+ClearGroupAttrResult result = client.group.clearGroupAttr(request);
+重置群自定义属性
App 管理员可以通过该接口重置群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持 |
| Public | 支持 |
| ChatRoom | 支持 |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
SetGroupAttrRequest request = new SetGroupAttrRequest();
+request.setGroupId("MyFirstGroup");
+GroupAttr groupAttr = new GroupAttr();
+groupAttr.setKey("isOpen");
+groupAttr.setValue("yes");
+List<GroupAttr> groupAttrs = Collections.singletonList(groupAttr);
+request.setGroupAttrs(groupAttrs);
+
+SetGroupAttrResult result = client.group.setGroupAttr(request);
+修改群聊历史消息
- 管理员修改群聊历史消息
- 可以单独修改消息中的 MsgBody 或 CloudCustomData 字段，也可以同时修改这两个字段。以请求中指定的字段值覆盖历史消息对应的字段。
- 不支持修改直播群的历史消息
注意
使用该接口修改消息后，被修改的消息不能恢复，请谨慎调用该接口。
使用示例：
ModifyGroupMsgRequest request = new ModifyGroupMsgRequest();
+request.setGroupId("MyFirstGroup");
+request.setMsgSeq(123L);
+TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+request.setMsgBody(msgBody);
+request.setMsgBody(msgBody);
+
+ModifyGroupMsgResult result = client.group.modifyGroupMsg(request);
+直播群广播消息
App 管理员可以通过该接口向所有直播群下发广播消息。
注意
直播群广播消息功能支持需要终端 SDK 6.5.2803 增强版及以上版本、Web SDK v2.21.0 及以上版本，需 购买旗舰版套餐包 并在 控制台>群功能配置>群功能配置>直播群广播消息 打开开关后方可使用。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持，发给所有直播群 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
SendBroadcastMsgRequest request = new SendBroadcastMsgRequest();
+request.setFromAccount("test1");
+TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+request.setMsgBody(msgBody);
+request.setRandom(1223L);
+
+SendBroadcastMsgResult result = client.group.sendBroadcastMsg(request);
+拉取群消息已读回执信息
App 管理员可以通过该接口拉取群消息已读回执信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work(好友工作群) |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 不支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMsgReceiptRequest request = new GetGroupMsgReceiptRequest();
+request.setGroupId("MyFirstGroup");
+MsgSeqItem seqItem = new MsgSeqItem();
+seqItem.setMsgSeq(123L);
+request.setMsgSeqList(Collections.singletonList(seqItem));
+
+GetGroupMsgReceiptResult result = client.group.getGroupMsgReceipt(request);
+拉取群消息已读回执详情
App 管理员可以通过该接口拉取群消息已读或未读成员列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work(好友工作群) |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 不支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMsgReceiptDetailRequest request = new GetGroupMsgReceiptDetailRequest();
+request.setGroupId("MyFirstGroup");
+request.setMsgSeq(123L);
+request.setNum(12);
+request.setCursor("");
+request.setFlag(12);
+
+GetGroupMsgReceiptDetailResult result = client.group.getGroupMsgReceiptDetail(request);
+创建话题
App 管理员可以通过该接口创建话题。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
CreateGroupTopicRequest request = new CreateGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFaceUrl("");
+
+CreateGroupTopicResult result = client.group.createGroupTopic(request);
+获取话题资料
App 管理员可以通过该接口获取话题资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupTopicRequest request = new GetGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setFromAccount("1400187352");
+
+GetGroupTopicResult result = client.group.getGroupTopic(request);
+修改话题资料
App 管理员可以通过该接口修改话题资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupTopicRequest request = new ModifyGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFaceUrl("");
+
+ModifyGroupTopicResult result = client.group.modifyGroupTopic(request);
+导入话题基础资料
App 管理员可以通过该接口导入话题，不会触发回调、不会下发通知；当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量话题数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ImportGroupTopicRequest request = new ImportGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFromAccount("123");
+
+ImportGroupTopicResult result = client.group.importGroupTopic(request);
+解散话题
App 管理员可以通过该接口解散话题。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
DestroyGroupTopicRequest request = new DestroyGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+
+DestroyGroupTopicResult result = client.group.destroyGroupTopic(request);
+获取封禁群成员列表
App 管理员可以通过该接口获取对应直播群的封禁成员列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupBanMemberRequest request = new GetGroupBanMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setLimit(10);
+request.setOffset(0);
+
+GetGroupBanMemberResult result = client.group.getGroupBanMember(request);
+群成员封禁
App 管理员可以通过该接口向直播群封禁成员，封禁后成员无法接收消息，并且封禁时间内无法再次进群。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
BanGroupMemberRequest request = new BanGroupMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setDuration(1000L);
+request.setMembersAccount(Arrays.asList("test1", "bingo"));
+request.setDescription("test");
+
+BanGroupMemberResult result = client.group.banGroupMember(request);
+群成员解封
App 管理员可以通过该接口向直播群解封成员，解封后，之前封禁的成员可重新进群获取消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
UnbanGroupMemberRequest request = new UnbanGroupMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setMembersAccount(Arrays.asList("test1", "bingo"));
+
+UnbanGroupMemberResult result = client.group.unbanGroupMember(request);
+拉取群消息扩展
App 管理员和群成员可以拉取消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条群消息可设置的最大键值对数量为 300 条。
- 被设置的群消息需要在发送时指定“支持消息扩展”，参见 在群组中发送普通消息。
使用示例：
GroupGetKeyValuesRequest request = GroupGetKeyValuesRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeq(1L)
+ .build();
+
+GroupGetKeyValuesResult result = client.group.groupGetKeyValues(request);
+设置群消息扩展
App 管理员和群成员可以为群聊普通消息设置消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条群消息可设置的最大键值对数量为 300 条。
- 被设置的群消息需要在发送时指定“支持消息扩展”，参见 在群组中发送普通消息。
使用示例：
GroupSetKeyValuesRequest request = GroupSetKeyValuesRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeq(1L)
+ .extensionList(Collections.singletonList(KeyValueSeq.builder()
+ .key("test")
+ .value("test")
+ .build()))
+ .build();
+
+GroupSetKeyValuesResult result = client.group.groupSetKeyValues(request);
+获取群计数器
App 管理员可以通过该接口获取群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
GetGroupCounterRequest request = GetGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+GetGroupCounterResult result = client.group.getGroupCounter(request);
+更新群计数器
App 管理员可以通过该接口更新（设置、递增、递减）群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
List<GroupCounterItem> groupCounter = new ArrayList<>();
+GroupCounterItem item = new GroupCounterItem();
+item.setKey("x");
+item.setValue(1L);
+groupCounter.add(item);
+UpdateGroupCounterRequest request = UpdateGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .groupCounter(groupCounter)
+ .mode(GroupCounterMode.SET)
+ .build();
+
+UpdateGroupCounterResult result = client.group.updateGroupCounter(request);
+删除群计数器
App 管理员可以通过该接口删除群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
DeleteGroupCounterRequest request = DeleteGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+DeleteGroupCounterResult result = client.group.deleteGroupCounter(request);
+设置/取消直播群管理员
App 管理员可以为直播群设置和取消管理员，当设置管理员时，被设置的账号可以不需要在直播群里，被设置为管理员之后，该账号即使离开直播群再重新进群也仍然是管理员。需要取消管理员身份时，需要调用本接口取消该用户的管理员身份。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。
使用示例：
ModifyAdminRequest request = ModifyAdminRequest.builder()
+ .groupId("MyFirstGroup")
+ .commandType(1)
+ .adminAccount(Arrays.asList("test1", "bingo"))
+ .build();
+
+ModifyAdminResult result = client.group.modifyAdmin(request);
+获取直播群管理员列表
App 管理员可以根据群组 ID 获取直播群管理员列表。该功能仅限旗舰版用户在 IM 控制台“群功能配置”中开启“直播群在线成员列表”后方可使用。
使用示例：
GetAdminListRequest request = GetAdminListRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+GetAdminListResult result = client.group.getAdminList(request);
+查询用户是否在直播群内
App 管理员可以根据群组 ID 查询一批用户是否在直播群内。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。
使用示例：
CheckMembersRequest request = CheckMembersRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount(Arrays.asList("test1", "bingo"))
+ .build();
+
+CheckMembersResult result = client.group.checkMembers(request);
+前提条件
已登录 即时通信 IM 控制台 并创建了应用。创建完成后，可以拿到
sdkAppId以及key。已创建 App 管理员账号
userId，也即identifier。
说明
“App 管理员”是对 App 具有最高管理权限的角色，可调用 REST API 接口，进行创建/解散群组、发送全员推送消息等操作。每个应用最多支持配置 10 个管理员。
SDK 环境依赖
- Java 8 及以上版本
- Maven
SDK 源码
SDK 源码请参见 GitHub。
项目贡献者
全员推送
全员推送
全员推送，用户运营利器，不仅支持全员发送特定内容，还可根据标签、属性，针对特定用户群体发送个性化内容，如会员活动、区域通知等，助力拉新、转化、促活等各个阶段运营工作的有效进行。
- 支持全员推送。
- 支持按用户属性推送。
- 支持按用户标签推送。
- 管理员推送消息，接收方看到消息发送者是管理员。
- 管理员指定某一账号向其他账号推送消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 支持消息离线存储，不支持漫游。
- 由于全员推送需要下发的账号数量巨大，下发完全部账号需要一定时间（根据账号总数而定，一般在一分钟内）。
- 支持只推在线用户，需要将 MsgLifeTime 参数设置为 0。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hi, beauty");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ImPushRequest request = ImPushRequest.builder()
+ .msgRandom(9312457L)
+ .msgBody(msgBody)
+ .fromAccount("admin")
+ .msgLifeTime(120)
+ .build();
+
+ImPushResult result = client.member.imPush(request);
+设置应用属性名称
每个应用可以设置自定义的用户属性，最多可以有 10 个。通过本接口可以设置每个属性的名称，设置完成后，即可用于按用户属性推送等。
使用示例：
Map<String, String> attrNames = new HashMap<>(3);
+attrNames.put("0", "sex");
+attrNames.put("1", "city");
+attrNames.put("2", "country");
+ImSetAttrNameRequest request = new ImSetAttrNameRequest(attrNames);
+
+ImSetAttrNameResult result = client.member.imSetAttrName(request);
+获取应用属性名称
管理员获取应用属性名称。使用前请先 设置应用属性名称 。
使用示例：
ImGetAttrNameRequest request = new ImGetAttrNameRequest();
+
+ImGetAttrNameResult result = client.member.imGetAttrName(request);
+获取用户属性
获取用户属性（必须以管理员账号调用）；每次最多只能获取 100 个用户的属性。使用前请先 设置应用属性名称 。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImGetAttrRequest request = new ImGetAttrRequest(toAccount);
+
+ImGetAttrResult result = client.member.imGetAttr(request);
+设置用户属性
管理员给用户设置属性。每次最多只能给 100 个用户设置属性。使用前请先 设置应用属性名称 。
使用示例：
Map<String, Object> attrs = new HashMap<>();
+attrs.put("sex", "attr1");
+attrs.put("city", "attr2");
+UserAttrItem item = new UserAttrItem("test1", attrs);
+List<UserAttrItem> userAttrs = Collections.singletonList(item);
+ImSetAttrRequest request = new ImSetAttrRequest(userAttrs);
+
+ImSetAttrResult result = client.member.imSetAttr(request);
+删除用户属性
管理员给用户删除属性。注意每次最多只能给 100 个用户删除属性。使用前请先 设置应用属性名称 。
使用示例：
Map<String, Object> attrs = new HashMap<>();
+attrs.put("sex", "attr1");
+attrs.put("city", "attr2");
+UserAttrItem item = UserAttrItem.builder()
+ .toAccount("test1")
+ .attrs(attrs)
+ .build();
+List<UserAttrItem> userAttrs = Collections.singletonList(item);
+ImRemoveAttrRequest request = new ImRemoveAttrRequest(userAttrs);
+
+ImRemoveAttrResult result = client.member.imRemoveAttr(request);
+获取用户标签
获取用户标签（必须以管理员账号调用）。每次最多只能获取 100 个用户的标签。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImGetTagRequest request = new ImGetTagRequest(toAccount);
+
+ImGetTagResult result = client.member.imGetTag(request);
+添加用户标签
管理员给用户添加标签。
注意
- 每次请求最多只能给 100 个用户添加标签，请求体中单个用户添加标签数最多为 10 个。
- 单个用户可设置最大标签数为 100 个，若用户当前标签超过 100，则添加新标签之前请先删除旧标签。
- 单个标签最大长度为 50 字节。
使用示例：
List<String> tags = Arrays.asList("a", "b");
+UserTagItem item = UserTagItem.builder()
+ .toAccount("test1")
+ .tags(tags)
+ .build();
+List<UserTagItem> userTags = Collections.singletonList(item);
+ImAddTagRequest request = new ImAddTagRequest(userTags);
+
+ImAddTagResult result = client.member.imAddTag(request);
+删除用户标签
管理员给用户删除标签。注意每次最多只能给 100 个用户删除标签。
使用示例：
List<String> tags = Arrays.asList("a", "b");
+UserTagItem item = UserTagItem.builder()
+ .toAccount("test1")
+ .tags(tags)
+ .build();
+List<UserTagItem> userTags = Collections.singletonList(item);
+ImRemoveTagRequest request = new ImRemoveTagRequest(userTags);
+
+ImRemoveTagResult result = client.member.imRemoveTag(request);
+删除所有用户标签
管理员给用户删除所有标签。注意每次最多只能给 100 个用户删除所有标签。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImRemoveAllTagsRequest request = new ImRemoveAllTagsRequest(toAccount);
+
+ImRemoveAllTagsResult result = client.member.imRemoveAllTags(request);
+单聊消息
单发单聊消息
- 管理员向账号发消息，接收方看到消息发送者是管理员。
- 管理员指定某一账号向其他账号发消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 该接口不会检查发送者和接收者的好友关系（包括黑名单），同时不会检查接收者是否被禁言。
- 该接口默认不会检查接收者对发送者是否设置了免打扰，如需检查，请在"SendMsgControl"字段填上"WithMuteNotifications"。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendMsgRequest request = SendMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .msgRandom(123L)
+ .msgBody(msgBody)
+ .syncOtherMachine(SyncOtherMachine.YES)
+ .msgTimeStamp(1631934058)
+ .msgLifeTime(604800)
+ .build();
+
+SendMsgResult result = client.message.sendMsg(request);
+批量发单聊消息
- 支持一次对最多 500 个用户进行单发消息。
- 与单发消息相比，该接口更适用于营销类消息、系统通知 tips 等时效性较强的消息。
- 若消息不需要计入未读数，也不需要存储聊天记录，则可将 MsgLifeTime 字段设置为 0，这样可以带来更快的消息下发速度。
- 管理员指定某一账号向目标账号批量发消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 该接口不触发回调请求。
- 该接口不会检查发送者和接收者的好友关系（包括黑名单），同时不会检查接收者是否被禁言。
- 该接口默认不会检查接收者对发送者是否设置了免打扰，如需检查，请在"SendMsgControl"字段填上"WithMuteNotifications"。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+TIMTextMsgElement msg = new TIMTextMsgElement("hi bingo");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+BatchSendMsgRequest request = BatchSendMsgRequest
+ .builder()
+ .toAccount(toAccount)
+ .msgRandom(123L)
+ .msgBody(msgBody)
+ .syncOtherMachine(SyncOtherMachine.NO)
+ .msgSeq(28460L)
+ .build();
+
+BatchSendMsgResult result = client.message.batchSendMsg(request);
+导入单聊消息
- 导入历史单聊消息到即时通信 IM。
- 平滑过渡期间，将原有即时通信实时单聊消息导入到即时通信 IM。
- 该接口会更新会话。
- 该接口不会触发回调。
- 对于同一个单聊会话的消息，该接口会根据 MsgSeq ， MsgRandom ， MsgTimeStamp 字段的值对导入的消息进行去重。仅当这三个字段的值都对应相同时，才判定消息是重复的，消息是否重复与消息内容本身无关。 另外，若两条消息的 MsgSeq ， MsgRandom ， MsgTimeStamp 字段对应相同，而 from_account 和 to_account 相反，则这两条消息也认为是重复的。
- 重复导入的消息不会覆盖之前已导入的消息（即消息内容以首次导入的为准）。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello bingo");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ImportMsgRequest request = ImportMsgRequest.builder()
+ .fromAccount("bingo")
+ .toAccount("test1")
+ .msgRandom(122L)
+ .msgTimeStamp(1557387418)
+ .msgBody(msgBody)
+ .build();
+
+ImportMsgResult result = client.message.importMsg(request);
+查询单聊消息
- 管理员按照时间范围查询某单聊会话的消息记录。
- 查询的单聊会话由请求中的 From_Account 和 To_Account 指定。查询结果包含会话双方互相发送的消息，具体每条消息的发送方和接收方由每条消息里的 From_Account 和 To_Account 指定。
- 一般情况下，请求中的 From_Account 和 To_Account 字段值互换，查询结果不变。但通过 单发单聊消息 或 批量发单聊消息 接口发送的消息，如果指定 SyncOtherMachine 值为 2，则需要指定正确的 From_Account 和 To_Account 字段值才能查询到该消息。 例如，通过 单发单聊消息 接口指定账号 A 给账号 B 发一条消息，同时指定 SyncOtherMachine 值为 2。则调用本接口时，From_Account 必须设置为账号 B，To_Account 必须设置为账号 A 才能查询到该消息。
- 查询结果包含被撤回的消息，由消息里的 MsgFlagBits 字段标识。
- 若想通过 撤回单聊消息 接口撤回某条消息，可先用本接口查询出该消息的 MsgKey，然后再调用撤回接口进行撤回。
- 可查询的消息记录的时间范围取决于漫游消息存储时长，默认是 7 天。支持在控制台修改消息漫游时长，延长消息漫游时长是增值服务。具体请参考 漫游消息存储。
- 若请求时间段内的消息总大小超过应答包体大小限制（目前为 13K）时，则需要续拉。您可以通过应答中的 Complete 字段查看是否已拉取请求的全部消息。
使用示例：
AdminGetRoamMsgRequest request = AdminGetRoamMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .maxCnt(123)
+ .minTime(1631934000)
+ .maxTime(1631934060)
+ .build();
+
+AdminRoamMsgResult result = client.message.getRoamMsg(request);
+
+List<MsgListItem> msgList = result.getMsgList();
+if (msgList != null && msgList.size() > 0) {
+ for (MsgListItem item : msgList) {
+ List<TIMMsgElement> msgBody = item.getMsgBody();
+ if (msgBody != null && msgList.size() > 0) {
+ for (TIMMsgElement msgElement : msgBody) {
+ // 根据 msgType 强转为对应的子类
+ if (Objects.equals(msgElement.getMsgType(), MsgType.TIM_CUSTOM_ELEM)) {
+ TIMCustomMsgElement t = (TIMCustomMsgElement) msgElement;
+ System.out.println(t.getMsgContent().getDesc());
+ } else if (Objects.equals(msgElement.getMsgType(), MsgType.TIM_TEXT_ELEM)) {
+ TIMTextMsgElement t = (TIMTextMsgElement) msgElement;
+ System.out.println(t.getMsgContent().getText());
+ }
+ }
+ }
+ }
+}
+撤回单聊消息
- 管理员撤回单聊消息。
- 该接口可以撤回所有单聊消息，包括客户端发出的单聊消息，由 单发 和 批量发 接口发出的单聊消息。
- 若需要撤回由客户端发出的单聊消息，您可以开通 发单聊消息之前回调 或 发单聊消息之后回调 ，通过该回调接口记录每条单聊消息的 MsgKey ，然后填在本接口的 MsgKey 字段进行撤回。您也可以通过 查询单聊消息 查询出待撤回的单聊消息的 MsgKey 后，填在本接口的 MsgKey 字段进行撤回。
- 若需要撤回由 单发 和 批量发 接口发出的单聊消息，需要记录这些接口回包里的 MsgKey 字段以进行撤回。
- 调用该接口撤回消息后，该条消息的离线、漫游存储，以及消息发送方和接收方的客户端的本地缓存都会被撤回。
- 该接口可撤回的单聊消息没有时间限制，即可以撤回任何时间的单聊消息。
注意
使用该接口撤回单聊消息后，被撤回的消息不能恢复，请谨慎调用该接口。
使用示例：
AdminMsgWithdrawRequest request = AdminMsgWithdrawRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("31906_833502_1572869830")
+ .build();
+
+AdminMsgWithdrawResult result = client.message.msgWithdraw(request);
+设置单聊消息已读
- 设置用户的某个单聊会话的消息已读。
使用示例：
AdminSetMsgReadRequest request = AdminSetMsgReadRequest.builder()
+ .reportAccount("test1")
+ .peerAccount("test2")
+ .build();
+
+AdminSetMsgReadResult result = client.message.setMsgRead(request);
+查询单聊未读消息计数
App 后台可以通过该接口查询特定账号的单聊总未读数（包含所有的单聊会话）或者单个单聊会话的未读数。
使用示例：
GetC2cUnreadMsgRequest request = new GetC2cUnreadMsgRequest("test2");
+List<String> peerAccount = Arrays.asList("test1", "bingo");
+request.setPeerAccount(peerAccount);
+
+C2cUnreadMsgNumResult result = client.message.getC2cUnreadMsgNum(request);
+修改单聊历史消息
- 管理员修改单聊历史消息。
- 可以单独修改消息中的 MsgBody 或 CloudCustomData 字段，也可以同时修改这两个字段。以请求中指定的字段值覆盖历史消息对应的字段。
- 待修改的单聊消息的 MsgKey 可通过以下方式获取：
注意
使用该接口修改消息后，被修改的消息不能恢复，请谨慎调用该接口。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("test modify c2c msg");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ModifyC2cMsgRequest request = ModifyC2cMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .msgKey("1353691732_123_1653995506")
+ .msgBody(msgBody)
+ .build();
+
+ModifyC2cMsgResult result = client.message.modifyC2cMsg(request);
+拉取单聊消息扩展
App 管理员和会话成员可以拉取消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条单聊消息可设置的最大键值对数量为 300 条。
- 被设置的单聊消息需要在发送时指定“支持消息扩展”，参见 单发单聊消息。
使用示例：
GetKeyValuesRequest request = GetKeyValuesRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("1353691732_123_1653995506")
+ .startSeq(1L)
+ .build();
+
+GetKeyValuesResult result = client.message.getKeyValues(request);
+设置单聊消息扩展
App 管理员和会话成员可以为单聊普通消息设置消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条单聊消息可设置的最大键值对数量为 300 条。
- 被设置的单聊消息需要在发送时指定“支持消息扩展”，参见 单发单聊消息。
使用示例：
SetKeyValuesRequest request = SetKeyValuesRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("1353691732_123_1653995506")
+ .build();
+
+SetKeyValuesResult result = client.message.setKeyValues(request);
+单向删除单聊历史消息
- App 管理员调用该接口单向删除一个单聊会话的多条消息。
- 只能以消息的发送方或接收方的身份去删除单聊会话的历史消息。
- 只能单向删除（以会话其中一方的身份去删除某条消息后，自己看不到这条消息，会话的对方仍然可以看到这条消息）
使用示例：
DeleteC2cMsgRambleRequest request = DeleteC2cMsgRambleRequest.builder()
+ .operatorAccount("test1")
+ .peerAccount("test2")
+ .msgKeyList(Collections.singletonList("1353691732_123_1653995506"))
+ .build();
+
+DeleteC2cMsgRambleResult result = client.message.deleteC2cMsgRamble(request);
+清空群聊历史消息
该 API 接口的作用是清空群聊中用户发送的历史消息。
此接口通过打标记实现 SDK 无法拉取的效果，并没有真的执行删除操作，Admin 用户仍然可以通过“拉取群聊历史消息”接口拉取已清空的历史消息。
使用示例：
ClearGroupMsgRequest request = ClearGroupMsgRequest.builder()
+ .groupId("test_group")
+ .msgSeq(123L)
+ .build();
+
+ClearGroupMsgResult result = client.message.clearGroupMsg(request);
+公众号管理
创建公众号
App 管理员可以通过该接口创建公众号。
使用示例：
CreateOfficialAccountRequest request = new CreateOfficialAccountRequest();
+request.setOwnerAccount("test");
+request.setName("test_official_account");
+
+CreateOfficialAccountResult result = client.officialAccount.createOfficialAccount(request);
+销毁公众号
App 管理员可以通过该接口销毁公众号。
使用示例：
DestroyOfficialAccountRequest request = new DestroyOfficialAccountRequest();
+request.setOfficialAccount("test_official_account_user_id");
+
+DestroyOfficialAccountResult result = client.officialAccount.destroyOfficialAccount(request);
+修改公众号资料
App 管理员可以通过该接口修改公众号的相关信息，如公众号的名称、头像、简介等
使用示例：
ModifyOfficialAccountBaseInfoRequest request = new ModifyOfficialAccountBaseInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setName("test_official_account2");
+
+ModifyOfficialAccountBaseInfoResult result = client.officialAccount.modifyOfficialAccountBaseInfo(request);
+获取公众号详细资料
App 管理员可以通过该接口获取公众号的相关资料信息。
使用示例：
GetOfficialAccountInfoRequest request = new GetOfficialAccountInfoRequest();
+request.setOfficialAccountIdList(Collections.singletonList(new OfficialAccountItem("test_official_account_user_id")));
+
+GetOfficialAccountInfoResult result = client.officialAccount.getOfficialAccountInfo(request);
+获取公众号的订阅成员资料
App 管理员可以通过该接口获取订阅某个公众号的所有用户信息.
使用示例：
GetSubscriberInfoRequest request = new GetSubscriberInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setLimit(10);
+request.setNext("");
+
+GetSubscriberInfoResult result = client.officialAccount.getSubscriberInfo(request);
+添加订阅者
App 管理员可以通过该接口使用户订阅某个公众号，成为公众号的订阅成员。
使用示例：
AddSubscriberRequest request = new AddSubscriberRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberList(Collections.singletonList(new OfficialAccountItem("test_subscriber_id")));
+
+AddSubscriberResult result = client.officialAccount.addSubscriber(request);
+删除订阅者
App 管理员可以通过该接口使用户取消订阅某个公众号，从公众号的订阅成员中移除。
使用示例：
DeleteSubscriberRequest request = new DeleteSubscriberRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberToDelAccount(Collections.singletonList("test_subscriber_id"));
+
+DeleteSubscriberResult result = client.officialAccount.deleteSubscriber(request);
+修改订阅者资料
App 管理员可以通过该接口修改订阅者的相关资料信息。
使用示例：
ModifySubscriberInfoRequest request = new ModifySubscriberInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberAccount("test_subscriber_id");
+request.setCustomString("test_custom_string");
+
+ModifySubscriberInfoResult result = client.officialAccount.modifySubscriberInfo(request);
+获取订阅的公众号列表
App 管理员可以通过该接口获取用户订阅的所有公众号列表信息。
使用示例：
GetSubscribedOfficialAccountListRequest request = new GetSubscribedOfficialAccountListRequest();
+request.setSubscriberAccount("test_subscriber_id");
+
+GetSubscribedOfficialAccountListResult result = client.officialAccount.getSubscribedOfficialAccountList(request);
+公众号用户发送广播消息
- App 管理员可以通过该接口向关注公众号的所有订阅者发送普通消息。
- 单个公众号的发送频率上限为1条/秒，每小时最多可发布2条广播消息。
- 如果5分钟内两条消息的内容相同，后面的消息将被当做重复消息而丢弃。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendOfficialAccountMsgRequest request = SendOfficialAccountMsgRequest.builder()
+ .officialAccount("test_official_account_user_id")
+ .random(123)
+ .msgBody(msgBody)
+ .build();
+
+SendOfficialAccountMsgResult result = client.officialAccount.sendOfficialAccountMsg(request);
+拉取公众号用户历史消息
- 即时通信 IM 的公众号消息是按 Seq 排序的，按照 server 收到公众号消息的顺序分配 Seq，先发的公众号消息 Seq 小，后发的 Seq 大。
- 即时通信 IM 会给每条公众号消息生成一个 MsgKey，格式为 "Seq_1_ServerTime"。
- 如果用户想拉取一个公众号的全量消息，需要填写消息的 LastMsgKey，首次拉取时不用填拉取 LastMsgKey，Server 会自动返回最新的消息，以后拉取时拉取 LastMsgKey 填上次请求返回 LastMsgKey。
- 如果返回消息的 IsPlaceMsg 为1，表示这个 Seq 的消息或者过期、或者存储失败、或者被删除了。
使用示例：
OfficialAccountMsgGetSimpleRequest request = new OfficialAccountMsgGetSimpleRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setLastMsgKey("msg_key");
+request.setReqMsgNumber(10);
+request.setWithRecalledMsg(1);
+
+OfficialAccountMsgGetSimpleResult result = client.officialAccount.msgGetSimple(request);
+撤回公众号消息
- 管理员撤回公众号消息。
- 该接口可以撤回所有漫游有效期内的公众号消息，包括客户端发出的公众号消息，由 REST API 接口发出的公众号消息。
- 若需要撤回由客户端发出的公众号消息，您可以开通 发公众号消息之后回调 ，通过该回调接口记录每条公众号消息的 MsgKey，然后填在本接口的 MsgKeyList 参数里进行撤回。您也可以通过 拉取公众号用户历史消息 查询出待撤回的公众号消息的相关信息后，使用本接口进行撤回。
- 若需要撤回由 REST API 公众号用户发送广播消息 接口发出的公众号消息，需要记录这些接口回包里的 MsgKey 字段以进行撤回。
- 调用该接口撤回消息后，该条消息的接收方的客户端的本地缓存都会被撤回。
- 该接口可撤回的公众号消息没有时间限制，即可以撤回任何时间的公众号消息，但是公众号消息的漫游时间需要在有效期内。
使用示例：
OfficialAccountMsgRecallRequest request = new OfficialAccountMsgRecallRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setMsgKeyList(Collections.singletonList("msg_key"));
+
+OfficialAccountMsgRecallResult result = client.officialAccount.msgRecall(request);
+全局禁言管理
设置全局禁言
- 设置账号的单聊消息全局禁言。
- 设置账号的群组消息全局禁言。
使用示例：
SetNoSpeakingRequest request = SetNoSpeakingRequest.builder()
+ .setAccount("test1")
+ .msgNoSpeakingTime(NoSpeakingTime.NEVER)
+ .groupMsgNoSpeakingTime(NoSpeakingTime.FOREVER)
+ .build();
+
+SetNoSpeakingResult result = client.operation.setNoSpeaking(request);
+查询全局禁言
- 查询账号的单聊消息全局禁言。
- 查询账号的群组消息全局禁言。
使用示例：
GetNoSpeakingRequest request = new GetNoSpeakingRequest("test1");
+
+GetNoSpeakingResult result = client.operation.getNoSpeaking(request);
+运营管理
拉取运营数据
App 管理员可以通过该接口拉取最近 30 天的运营数据，可拉取的字段见下文可拉取的运营字段。
使用示例：
GetAppInfoRequest request = new GetAppInfoRequest();
+List<String> requestFields = Arrays.asList("ChainIncrease", "ChainDecrease");
+request.setRequestField(requestFields);
+
+GetAppInfoResult result = client.operation.getAppInfo(request);
+下载最近消息记录
App 管理员可以通过该接口获取 App 中最近 7 天中某天某小时的所有单发或群组消息记录的下载地址。
注意
- 下载消息记录里的图片、语音、文件和短视频，此功能仅适用于 4.X 版本 IM SDK，可通过聊天记录中的 URL 字段进行下载。如您使用 2.X 或 3.X 版本的 IM SDK，您将无法通过该方法获取到以上信息，如您需要此功能，请您升级至 4.X 版本。
- 消息记录以日志文件形式保存并使用 GZip 压缩，通过该接口获取到下载地址后，请自行下载并处理；消息记录文件每小时产生一次，例如 0 点（00:00~00:59）的数据在 01:00 后开始处理，一般 1 小时内处理完毕（消息较多则处理时间较长）；文件有效期 7 天，无论是否下载过，都会在 7 天后删除，被删除后不支持重新导出；获取到的下载地址存在有效期，请在过期前进行下载，若地址失效，请通过该接口重新获取。
- 此接口仅用于下载最近 7 天的聊天记录文件，用于备份或数据统计等。不建议使用该接口用于线上实时业务。
使用示例：
GetHistoryRequest request = GetHistoryRequest.builder()
+ .chatType(ChatType.C2C)
+ .msgTime("2015120121")
+ .build();
+
+GetHistoryResult result = client.operation.getHistory(request);
+获取服务器 IP 地址
基于安全等考虑，您可能需要获知服务器的 IP 地址列表，以便进行相关限制。App 管理员可以通过该接口获得 SDK、第三方回调所使用到的服务器 IP 地址列表或 IP 网段信息。
注意
此接口仅支持获取中国大陆地区的所有 IM 接入方式的 IP 地址或 IP 网段信息。
使用示例：
GetIpListRequest request = new GetIpListRequest();
+
+GetIpListResult result = client.op~eration.getIpList(request);
+聊天文件封禁
本接口用于封禁聊天消息中的富媒体文件。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
使用示例：
ForbidIllegalObjectRequest request = ForbidIllegalObjectRequest.builder()
+ .rawUrl("https://cos.ap-shanghai.myqcloud.com/005f-shanghai-360-shared-01-1256635546/76aa-1400152839/2f3b-2273451635034382/699eb4ee5ffa9aeb70627958766f2927-142072.jpg")
+ .build();
+
+ForbidIllegalObjectResult result = client.operation.forbidIllegalObject(request);
+聊天文件解封
本接口用于解封聊天消息中的富媒体文件。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
AllowBannedObjectRequest request = AllowBannedObjectRequest.builder()
+ .rawUrl("https://cos.ap-shanghai.myqcloud.com/005f-shanghai-360-shared-01-1256635546/76aa-1400152839/2f3b-2273451635034382/699eb4ee5ffa9aeb70627958766f2927-142072.jpg")
+ .build();
+
+AllowBannedObjectResult result = client.operation.allowBannedObject(request);
+聊天文件签名
本接口用于获取聊天消息中的富媒体文件 FULL_CONTROL 权限的 URL 签名以及文件状态信息，默认有效期 15 分钟。一般 SDK 下发的文件 URL 为普通账号签名，违规封禁后，可以使用 FULL_CONTROL 权限的 URL 签名来查看封禁的资源。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
RawUrlItem item = new RawUrlItem();
+item.setRawUrl("https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc6.png");
+item.setResourceId(1);
+List<RawUrlItem> rawUrls = Collections.singletonList(item);
+GetCosSigRequest request = GetCosSigRequest.builder()
+ .rawUrls(rawUrls)
+ .build();
+
+GetCosSigResult result = client.operation.getCosSig(request);
+资料管理
设置资料
使用示例：
ProfileItem profileItem = ProfileItem.builder()
+ .tag(TagProfile.IM_NICK)
+ .value("MyNickName")
+ .build();
+List<ProfileItem> profiles = Collections.singletonList(profileItem);
+PortraitSetRequest request = PortraitSetRequest.builder()
+ .fromAccount("test1")
+ .profileItemList(profiles)
+ .build();
+
+PortraitSetResult result = client.profile.portraitSet(request);
+拉取资料
- 支持拉取好友和非好友的资料字段。
- 支持拉取 标配资料字段 和 自定义资料字段。
- 建议每次拉取的用户数不超过 100，避免因回包数据量太大导致回包失败。
- 请确保请求中的所有账号都已导入即时通信 IM，如果请求中含有未导入即时通信 IM 的账号，即时通信 IM 后台将会提示错误。
使用示例：
List<String> tagList = Collections.singletonList(TagProfile.IM_NICK);
+List<String> toAccount = Collections.singletonList("test1");
+PortraitGetRequest request = PortraitGetRequest.builder()
+ .tagList(tagList)
+ .toAccount(toAccount)
+ .build();
+
+PortraitGetResult result = client.profile.portraitGet(request);
+快速上手
安装
Maven
在项目的 pom.xml 的 dependencies 中引入以下依赖:
<dependency>
+ <groupId>io.github.doocs</groupId>
+ <artifactId>im-server-sdk-java</artifactId>
+ <version>0.4.10</version>
+</dependency>
+Gradle
implementation group: 'io.github.doocs', name: 'im-server-sdk-java', version: '0.4.10'
+下载 JAR
初始化
在使用腾讯云即时 IM 服务端 REST API 之前， 需要先通过 appId, userId, key 获取到一个 ImClient 实例:
// sdk appId
+long appId = 1400554812;
+
+// admin userId
+String userId = "test";
+
+// application key
+String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";
+
+// create a default ImClient instance
+ImClient client = ImClient.getInstance(appId, userId, key);
+
+// create a default ImClient instance with custom domain
+ImClient client = ImClient.getInstance(appId, userId, key, Domain.SINGAPORE);
+
+// create a custom ImClient instance
+ClientConfiguration config = new ClientConfiguration();
+config.setExpireTime(7 * 24 * 60 * 60L);
+config.setAutoRenewSig(false);
+ImClient client = ImClient.getInstance(appId, userId, key, config);
+ClientConfiguration 支持对以下参数进行自定义配置：
| 字段 | 类型 | 说明 | 默认值 |
|---|---|---|---|
maxRetries | int | HTTP 最大重试次数 | 3 |
connectTimeout | long | HTTP 连接超时（毫秒） | 10_000 |
readTimeout | long | HTTP 读超时（毫秒） | 10_000 |
writeTimeout | long | HTTP 写超时（毫秒） | 10_000 |
callTimeout | long | 一个完整的 HTTP 调用的时间限制。这包括解析 DNS、连接、写入请求正文、服务器处理以及读取响应正文。（毫秒） | 30_000 |
expireTime | long | UserSig 签名有效时长（秒） | 86400 |
autoRenewSig | boolean | 是否自动进行 UserSig 签名续期 | true |
userAgent | string | User-Agent | |
connectionPool | object | HTTP 连接池 |
使用示例
获取到 ImClient 实例后，就可以方便地进行 REST API 调用了。
AccountImportRequest request = AccountImportRequest.builder()
+ .identifier("admin")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .nick("doocs")
+ .build();
+
+AccountImportResult result = client.account.accountImport(request);
+最近联系人
拉取会话列表
支持分页拉取会话列表。
使用示例：
GetRecentContactListRequest request = GetRecentContactListRequest.builder()
+ .fromAccount("doocs")
+ .timestamp(0)
+ .startIndex(0)
+ .topTimestamp(0)
+ .topStartIndex(0)
+ .assistFlags(AssistFlags.BIT_0)
+ .build();
+
+GetRecentContactListResult result = client.recentContact.recentContactList(request);
+删除单个会话
删除指定会话，支持同步清理漫游消息。
使用示例：
DeleteRecentContactRequest request = DeleteRecentContactRequest.builder()
+ .fromAccount("doocs_1")
+ .type(RecentContactType.C2C)
+ .toAccount("doocs_2")
+ .clearRamble(ClearRamble.YES)
+ .build();
+
+DeleteRecentContactResult result = client.recentContact.deleteRecentContact(request);
+创建会话分组数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记最多支持 1000 个会话，而一个用户最多支持 20 个会话分组。本接口支持会话分组数据的创建，仅旗舰版支持会话分组数据操作。
使用示例：
List<GroupContactItem> items = new ArrayList<>();
+GroupContactItem item = new GroupContactItem();
+item.setGroupName("groupName");
+
+List<ContactItem> contactItems = new ArrayList<>();
+ContactItem contactItem = new ContactItem();
+contactItem.setToAccount("ccc");
+contactItem.setToGroupId("group1");
+contactItem.setType(1);
+contactItems.add(contactItem);
+item.setContactItem(contactItems);
+items.add(item);
+CreateContactGroupRequest request = CreateContactGroupRequest.builder()
+ .fromAccount("test1")
+ .groupContactItem(items).build();
+
+CreateContactGroupResult result = client.recentContact.createContactGroup(request);
+更新会话分组数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记数据最多支持 1000 个会话。本接口支持会话分组数据的更新，仅旗舰版支持会话分组数据操作。
使用示例：
UpdateGroup updateGroup = UpdateGroup.builder().updateGroupType(1)
+ .newGroupName("hh").oldGroupName("cc").build();
+UpdateContactGroupRequest request = UpdateContactGroupRequest.builder()
+ .updateType(1)
+ .fromAccount("test1")
+ .updateGroup(updateGroup)
+ .build();
+
+UpdateContactGroupResult result = client.recentContact.updateContactGroup(request);
+删除会话分组数据
本接口支持删除用户的会话分组数据，仅旗舰版支持会话分组数据操作。
使用示例：
List<String> groupName = new ArrayList<>();
+groupName.add("hh");
+DelContactGroupRequest request = DelContactGroupRequest.builder()
+ .groupName(groupName)
+ .fromAccount("test1")
+ .build();
+
+DelContactGroupResult result = client.recentContact.delContactGroup(request);
+创建或更新会话标记数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记最多支持 1000 个会话。本接口支持会话标准标记以及会话自定义标记的创建或更新，仅旗舰版支持会话标准标记数据操作，自定义会话标记数据无限制。
使用示例：
List<MarkContactItem> items = new ArrayList<>();
+MarkContactItem item = new MarkContactItem();
+item.setClearMark(Collections.singletonList(1));
+item.setSetMark(Collections.singletonList(2));
+item.setOptType(1);
+items.add(item);
+MarkContactRequest request = MarkContactRequest.builder()
+ .fromAccount("test1")
+ .markItem(items)
+ .build();
+
+MarkContactResult result = client.recentContact.markContact(request);
+搜索会话分组标记
本接口根据指定的会话来查询对应会话分组标记数据。
使用示例：
SearchContactGroupRequest request = new SearchContactGroupRequest();
+request.setFromAccount("test1");
+ContactItem contactItem = new ContactItem();
+contactItem.setType(1);
+contactItem.setToAccount("test2");
+contactItem.setToGroupId("123");
+request.setContactItem(Collections.singletonList(contactItem));
+
+SearchContactGroupResult result = client.recentContact.searchContactGroup(request);
+拉取会话分组标记数据
本接口支持批量获取用户的会话分组标记数据。
使用示例：
GetContactGroupRequest request = new GetContactGroupRequest();
+request.setFromAccount("test1");
+request.setStartIndex(1);
+
+GetContactGroupResult result = client.recentContact.getContactGroup(request);
+机器人
创建机器人
本接口用于创建一个机器人账号，机器人是一种特殊账号，userid 必须以 @RBT# 开头，创建机器人时可以指定设置昵称、头像和签名。
说明
- 同一个机器人账号 userid 重复创建仅会创建 1 个机器人。
- 每个 IM 账号只能创建最多 20 个机器人账号。
使用示例：
CreateRobotRequest request = new CreateRobotRequest();
+request.setNick("bingo");
+request.setFaceUrl("https://avatars.githubusercontent.com/u/2784452?v=4");
+request.setSelfSignature("hah");
+request.setUserId("@RBT#1233232");
+
+CreateRobotResult result = client.robot.createRobot(request);
+删除机器人
本接口用于将一个机器人账号设置为无效，机器人是一种特殊账号，userid 必须以 @RBT# 开头。
说明
- 本接口将一个机器人账号设置为无效。
- 机器人账号 UserID 本身不会被删除。
使用示例：
DeleteRobotRequest request = DeleteRobotRequest.builder().robotAccount("@RBT#1233232").build();
+
+DeleteRobotResult result = client.robot.deleteRobot(request);
+拉取所有机器人
本接口用于拉取所有的机器人账号列表，机器人是一种特殊账号，userid 必须以 @RBT# 开头。
使用示例：
GetAllRobotsRequest request = new GetAllRobotsRequest();
+
+GetAllRobotsResult result = client.robot.getAllRobots(request);
+关系链管理
添加好友
添加好友，支持批量添加好友。
使用示例：
AddFriendItem addFriendItem = AddFriendItem.builder()
+ .toAccount("test2")
+ .addSource("AddSource_Type_XXXXXXXX")
+ .remark("Mr.A")
+ .groupName("schoolmate")
+ .addWording("Hi")
+ .build();
+List<AddFriendItem> addFriendItemList = Collections.singletonList(addFriendItem);
+FriendAddRequest request = FriendAddRequest.builder()
+ .fromAccount("test1")
+ .addFriendItemList(addFriendItemList)
+ .addType(AddType.BOTH)
+ .forceAddFlags(ForceAddFlags.FORCE)
+ .build();
+
+FriendAddResult result = client.sns.friendAdd(request);
+导入好友
- 支持批量导入单向好友。
- 往同一个用户导入好友时建议采用批量导入的方式，避免并发写导致的写冲突。
使用示例：
ImportFriendItem importFriendItem = ImportFriendItem.builder()
+ .toAccount("test2")
+ .addSource("AddSource_Type_XXXXXXXX")
+ .build();
+List<ImportFriendItem> importFriendItems = Collections.singletonList(importFriendItem);
+FriendImportRequest request = FriendImportRequest.builder()
+ .fromAccount("test1")
+ .importFriendItemList(importFriendItems)
+ .build();
+
+FriendImportResult result = client.sns.friendImport(request);
+更新好友
- 支持批量更新同一用户的多个好友的关系链数据。
- 更新一个用户多个好友时，建议采用批量方式，避免并发写导致的写冲突。
使用示例：
SnsItem snsItem = SnsItem.builder()
+ .tag("Tag_SNS_Custom_testTag")
+ .value(TagSns.IM_ADD_WORDING)
+ .build();
+List<SnsItem> snsItems = Collections.singletonList(snsItem);
+UpdateItem updateItem = UpdateItem.builder()
+ .toAccount("test2")
+ .snsItemList(snsItems)
+ .build();
+List<UpdateItem> updateItems = Collections.singletonList(updateItem);
+FriendUpdateRequest request = FriendUpdateRequest.builder()
+ .fromAccount("test1")
+ .updateItemList(updateItems)
+ .build();
+
+FriendUpdateResult result = client.sns.friendUpdate(request);
+删除好友
删除好友，支持单向删除好友和双向删除好友。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+FriendDeleteRequest request = FriendDeleteRequest.builder()
+ .deleteType(DeleteType.BOTH)
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+FriendDeleteResult result = client.sns.friendDelete(request);
+删除所有好友
清除指定用户的标配好友数据和自定义好友数据。
使用示例：
FriendDeleteAllRequest request = FriendDeleteAllRequest.builder()
+ .deleteType(DeleteType.BOTH)
+ .fromAccount("test1")
+ .build();
+
+FriendDeleteAllResult result = client.sns.friendDeleteAll(request);
+校验好友
支持批量校验好友关系。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+FriendCheckRequest request = FriendCheckRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .checkType(CheckResultType.BOTH)
+ .build();
+
+FriendCheckResult result = client.sns.friendCheck(request);
+拉取好友
- 分页拉取全量好友数据。
- 不支持资料数据的拉取。
- 不需要指定请求拉取的字段，默认返回全量的标配好友数据和自定义好友数据。
使用示例：
FriendGetRequest request = FriendGetRequest.builder()
+ .fromAccount("test1")
+ .startIndex(0)
+ .standardSequence(0)
+ .customSequence(0)
+ .build();
+
+FriendGetResult result = client.sns.friendGet(request);
+拉取指定好友
- 支持拉取指定好友的好友数据和资料数据。
- 建议每次拉取的好友数不超过 100，避免因数据量太大导致回包失败。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+List<String> tagList = Arrays.asList(TagProfile.IM_ADMIN_FORBID_TYPE, TagProfile.IM_ALLOW_TYPE);
+FriendGetListRequest request = FriendGetListRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .tagList(tagList)
+ .build();
+
+FriendGetListResult result = client.sns.friendGetList(request);
+添加黑名单
添加黑名单，支持批量添加黑名单。
注意
- 如果用户 A 与用户 B 之间存在好友关系，拉黑时会解除双向好友关系。
- 如果用户 A 与用户 B 之间存在黑名单关系，二者之间无法发起加好友请求。
- 如果用户 A 的黑名单中有用户 B 且用户 B 的黑名单中有用户 A，二者之间无法发起会话。
- 如果用户 A 的黑名单中有用户 B 但用户 B 的黑名单中没有用户 A，那么用户 A 可以给用户 B 发消息，用户 B 不能给用户 A 发消息。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListAddRequest request = BlackListAddRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+BlackListAddResult result = client.sns.blackListAdd(request);
+删除黑名单
删除指定黑名单。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListDeleteRequest request = BlackListDeleteRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+BlackListDeleteResult result = client.sns.blackListDelete(request);
+拉取黑名单
支持分页拉取所有黑名单。
使用示例：
BlackListGetRequest request = BlackListGetRequest.builder()
+ .fromAccount("test1")
+ .startIndex(0)
+ .maxLimited(10)
+ .lastSequence(0)
+ .build();
+
+BlackListGetResult result = client.sns.blackListGet(request);
+校验黑名单
支持批量校验黑名单。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListCheckRequest request = BlackListCheckRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .checkType(BlackCheckResultType.BOTH)
+ .build();
+
+BlackListCheckResult result = client.sns.blackListCheck(request);
+添加分组
添加分组，支持批量添加分组，并将指定好友加入到新增分组中。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+List<String> toAccount = Collections.singletonList("test2");
+GroupAddRequest request = GroupAddRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .toAccount(toAccount)
+ .build();
+
+GroupAddResult result = client.sns.groupAdd(request);
+删除分组
删除指定分组。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+GroupDeleteRequest request = GroupDeleteRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .build();
+
+GroupDeleteResult result = client.sns.groupDelete(request);
+拉取分组
拉取分组，支持指定分组以及拉取分组下的好友列表。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+GroupGetRequest request = GroupGetRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .needFriend(NeedFriendType.YES)
+ .build();
+
+GroupGetResult result = client.sns.groupGet(request);
+
账号管理
导入单个账号
本接口用于将 App 自有账号导入即时通信 IM 账号系统，为该账号创建一个对应的内部 ID，使该账号能够使用即时通信 IM 服务。
说明
同一个账号重复导入仅会创建 1 个内部 ID。
使用示例：
AccountImportRequest request = AccountImportRequest.builder()
+ .userId("admin")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .nick("doocs")
+ .build();
+
+AccountImportResult result = client.account.accountImport(request);
+导入多个账号
本接口用于批量将 App 自有账号导入即时通信 IM 账号系统，为该账号创建一个对应的内部 ID，使该账号能够使用即时通信 IM 服务。
注意： 本接口单次最多支持导入 100 个账号，且不支持导入账号的昵称和头像信息。请使用 资料管理-设置资料 设置其他信息。
使用示例：
List<String> accounts = new ArrayList<>();
+accounts.add("user1");
+accounts.add("user2");
+MultiAccountImportRequest request = new MultiAccountImportRequest(accounts);
+
+MultiAccountImportResult result = client.account.multiAccountImport(request);
+删除账号
- 仅支持删除套餐包类型为 IM 体验版的账号，其他类型的账号（如：TRTC、白板、专业版、旗舰版）无法删除。
- 账号删除时，该用户的关系链、资料等数据也会被删除
- 账号删除后，该用户的数据将无法恢复，请谨慎使用该接口。
使用示例：
AccountDeleteItem item1 = AccountDeleteItem.builder().userId("user1").build();
+AccountDeleteItem item2 = AccountDeleteItem.builder().userId("user2").build();
+List<AccountDeleteItem> deleteItems = Arrays.asList(item1, item2);
+AccountDeleteRequest request = new AccountDeleteRequest(deleteItems);
+
+AccountDeleteResult result = client.account.accountDelete(request);
+查询账号
用于查询自有账号是否已导入即时通信 IM, 支持批量查询。
使用示例：
AccountCheckItem item1 = new AccountCheckItem("user1");
+AccountCheckItem item2 = new AccountCheckItem("user2");
+List<AccountCheckItem> checkItems = Arrays.asList(item1, item2);
+AccountCheckRequest request = new AccountCheckRequest(checkItems);
+
+AccountCheckResult result = client.account.accountCheck(request);
+失效账号登录状态
本接口适用于将 App 用户账号的登录状态（例如 UserSig）失效。
例如，开发者判断一个用户为恶意账号后，可以调用本接口将该用户当前的登录状态失效，这样用户使用历史 UserSig 登录即时通信 IM 会失败。
注意
支持一次失效一个账号，用户可以使用重新生成的 UserSig 登录即时通信 IM
使用示例：
KickRequest request = new KickRequest("user2");
+
+KickResult result = client.account.kick(request);
+查询账号在线状态
获取用户当前的登录状态。
使用示例：
List<String> toAccount = Arrays.asList("user1", "user2");
+QueryOnlineStatusRequest request = QueryOnlineStatusRequest.builder()
+ .toAccount(toAccount)
+ .isNeedDetail(IsNeedDetail.YES)
+ .build();
+
+QueryOnlineStatusResult result = client.account.queryOnlineStatus(request);
+内容审核
添加敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
LocalAuditWord word = new LocalAuditWord();
+word.setFilterType(AuditFilterType.REPLACE);
+word.setWordType(AuditWordType.SENSITIVE_WORDS);
+word.setKeyword("caonima");
+word.setReplacedContent("****");
+AddLocalAuditKeywordsRequest request = AddLocalAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .localAuditWords(Collections.singletonList(word)).build();
+
+AddLocalAuditKeywordsResult result = client.audit.addLocalAuditKeywords(request);
+删除敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
DeleteLocalAuditKeywordsRequest request = new DeleteLocalAuditKeywordsRequest();
+request.setSdkAppId(1400594307);
+LocalAuditWord word = new LocalAuditWord();
+word.setId(1L);
+word.setReplacedContent("****");
+word.setKeyword("caonima");
+word.setWordType(AuditWordType.SENSITIVE_WORDS);
+word.setFilterType(AuditFilterType.REPLACE);
+request.setLocalAuditWords(Collections.singletonList(word));
+
+DeleteLocalAuditKeywordsResult result = client.audit.deleteLocalAuditKeywords(request);
+获取敏感词（本地审核）
开启本地审核后，在 App 后台可以主动调用 REST API 接口，增删改查本地审核相关词库。
使用示例：
GetLocalAuditKeywordsRequest request = GetLocalAuditKeywordsRequest.builder().keyword("caonima")
+ .filterType(AuditFilterType.REPLACE)
+ .limit(1).offset(0).sdkAppId(1400594307).build();
+
+GetLocalAuditKeywordsResult result = client.audit.getLocalAuditKeywords(request);
+主动审核接口（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，送审音视图文等相关内容，其中图文同步返回机审结果，音视频通过异步回调的形式返回机审结果。
使用示例：
ContentModerationRequest request = ContentModerationRequest.builder().content("122")
+ .contentType(AuditContentType.TEXT)
+ .auditName(AuditNameType.C2C)
+ .build();
+
+ContentModerationResult result = client.audit.contentModeration(request);
+主动批量审核接口（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，批量送审图文等相关内容，音视频审核请查看主动审核接口。
使用示例：
BatchContentModerationRequest request = new BatchContentModerationRequest();
+request.setAuditName(AuditNameType.GROUP);
+AuditContentItem item1 = new AuditContentItem();
+item1.setContent("f*ck uuu");
+item1.setContentId(323245334);
+item1.setContentType(AuditContentType.TEXT);
+AuditContentItem item2 = AuditContentItem.builder()
+ .contentId(435545)
+ .contentType(AuditContentType.TEXT)
+ .content("cnm").build();
+request.setContents(Arrays.asList(item1, item2));
+
+BatchContentModerationResult result = client.audit.batchContentModeration(request);
+获取词库列表（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
GetCloudAuditKeyWordsIdsRequest request = GetCloudAuditKeyWordsIdsRequest.builder()
+ .limit(1)
+ .offset(0)
+ .sdkAppId(1400594307)
+ .build();
+
+GetCloudAuditKeywordsIdsResult result = client.audit.getCloudAuditKeywordsIds(request);
+获取敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
GetCloudAuditKeyWordsRequest request = GetCloudAuditKeyWordsRequest.builder()
+ .libId("fd")
+ .limit(1)
+ .offset(0)
+ .sdkAppId(1400594307)
+ .build();
+
+GetCloudAuditKeywordsResult result = client.audit.getCloudAuditKeywords(request);
+添加敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 RESTA PI 接口，增删改查云端审核相关词库。
使用示例：
UserKeyword userKeyword = new UserKeyword();
+userKeyword.setContent("caonima");
+userKeyword.setLabel(ContentModerationLabel.COMPOSITE);
+AddCloudAuditKeywordsRequest request = AddCloudAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .libId("fd")
+ .userKeywords(Collections.singletonList(userKeyword))
+ .build();
+
+AddCloudAuditKeywordsResult result = client.audit.addCloudAuditKeywords(request);
+删除敏感词（云端审核）
开启云端审核后，在 App 后台可以主动调用 REST API 接口，增删改查云端审核相关词库。
使用示例：
DeleteCloudAuditKeywordsRequest request = DeleteCloudAuditKeywordsRequest.builder()
+ .sdkAppId(1400594307)
+ .libId("fd")
+ .keywords(Arrays.asList("caonima", "wtf")).build();
+
+DeleteCloudAuditKeywordsResult result = client.audit.deleteCloudAuditKeywords(request);
+群组管理
获取 App 中的所有群组
App 管理员可以通过该接口获取 App 中所有群组的 ID。
说明
即时通信 IM 内置多种群组类型，详情请参见 群组系统。
使用示例：
GetAppIdGroupListRequest request = GetAppIdGroupListRequest.builder()
+ .limit(10)
+ .groupType(GroupType.PUBLIC)
+ .next(0)
+ .build();
+
+GetAppIdGroupListResult result = client.group.getAppIdGroupList(request);
+创建群组
App 管理员可以通过该接口创建群组。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，用户（包括群主）使用 AVChatroom（直播群）时必须操作 SDK 主动申请进群 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
CreateGroupRequest request = CreateGroupRequest.builder()
+ .type(GroupType.PUBLIC)
+ .name("TestGroup")
+ .ownerAccount("user1")
+ .groupId("MyFirstGroup")
+ .introduction("This is group Introduction")
+ .notification("This is group Notification")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .maxMemberCount(500)
+ .applyJoinOption(ApplyJoinOption.FREE_ACCESS)
+ .inviteJoinOption(InviteJoinOption.DISABLE_INVITE)
+ .build();
+
+CreateGroupResult result = client.group.createGroup(request);
+获取群详细资料
App 管理员可以根据群组 ID 获取群组的详细信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<String> groupIdList = Collections.singletonList("MyFirstGroup");
+GetGroupInfoRequest request = new GetGroupInfoRequest(groupIdList);
+
+GetGroupInfoResult result = client.group.getGroupInfo(request);
+获取群成员详细资料
App 管理员可以根据群组 ID 获取群组成员的资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持，使用 Next 字段分批获取 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
因 Community（社群）人数较多，分页获取方式改用 Next 分批方法。
使用示例：
GetGroupMemberInfoRequest request = GetGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .limit(100)
+ .offset(0)
+ .build();
+
+GetGroupMemberInfoResult result = client.group.getGroupMemberInfo(request);
+获取指定群成员详细资料
App 管理员可根据群组 ID 与群内指定成员 UserID 列表等参数获取指定群组成员的资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetSpecifiedGroupMemberInfoRequest request = GetSpecifiedGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberInfoFilter(Collections.singletonList("bingo"))
+ .build();
+
+GetSpecifiedGroupMemberInfoResult result = client.group.getSpecifiedGroupMemberInfo(request);
+修改群基础资料
App 管理员可以通过该接口修改指定群组的基础信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupBaseInfoRequest request = ModifyGroupBaseInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .name("groupName")
+ .introduction("my first group")
+ .notification("hello world!")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .maxMemberNum(500)
+ .applyJoinOption(ApplyJoinOption.NEED_PERMISSION)
+ .muteAllMember(MuteAllMember.OFF)
+ .build();
+
+ModifyGroupBaseInfoResult result = client.group.modifyGroupBaseInfo(request);
+增加群成员
App 管理员可以通过该接口向指定的群中添加新成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom(直播群)不支持增加群成员，对此类型群组进行操作时会返回 10007 错误。用户加入此类型群组的唯一方式是用户申请加群。
使用示例：
MemberRequestItem item = new MemberRequestItem("user2");
+List<MemberRequestItem> memberList = Collections.singletonList(item);
+AddGroupMemberRequest request = AddGroupMemberRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberList(memberList)
+ .silence(1)
+ .build();
+
+AddGroupMemberResult result = client.group.addGroupMember(request);
+删除群成员
App 管理员可以通过该接口删除群成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持删除群成员，对这种类型的群组进行操作时会返回 10004 错误。如果管理员希望达到删除群成员的效果，可以通过设置 批量禁言和取消禁言 的方式实现。
使用示例：
List<String> toDelAccount = Collections.singletonList("user2");
+DeleteGroupMemberRequest request = DeleteGroupMemberRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberToDelAccount(toDelAccount)
+ .build();
+
+DeleteGroupMemberResult result = client.group.deleteGroupMember(request);
+修改群成员资料
App 管理员可以通过该接口修改群成员资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不存储群成员资料，所以不能修改成员资料。只能修改管理员和群主的成员资料，修改普通成员资料时会返回 10007 错误。
使用示例：
ModifyGroupMemberInfoRequest request = ModifyGroupMemberInfoRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount("doocs")
+ .nameCard("hello World!")
+ .build();
+
+ModifyGroupMemberInfoResult result = client.group.modifyGroupMemberInfo(request);
+解散群组
App 管理员通过该接口解散群。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
DestroyGroupRequest request = new DestroyGroupRequest("MyFirstGroup");
+
+DestroyGroupResult result = client.group.destroyGroup(request);
+获取用户所加入的群组
App 管理员可以通过本接口获取某一用户加入的群信息。默认不获取用户已加入但未激活好友工作群（Work）以及直播群（AVChatRoom）群信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群），但默认不返回已加入但未激活的此类型群信息 |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，但默认不返回此类型群信息。如果指定拉取 AVChatRoom 类型群信息，获得的群信息可能不完整，AVChatRoom 并不存储所有的群成员资料。 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetJoinedGroupListRequest request = new GetJoinedGroupListRequest("doocs");
+
+GetJoinGroupListResult result = client.group.getJoinGroupList(request);
+查询用户在群组中的身份
App 管理员可以通过该接口获取一批用户在群内的身份，即“成员角色”。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持该接口，对此类型群组进行操作将返回 10007 错误；但可以通过 获取群组成员详细资料 达到查询“成员角色”的效果。
使用示例：
List<String> userAccount = Collections.singletonList("doocs");
+GetRoleInGroupRequest request = GetRoleInGroupRequest.builder()
+ .groupId("MyFirstGroup")
+ .userAccount(userAccount)
+ .build();
+
+GetRoleInGroupResult result = client.group.getRoleInGroup(request);
+批量禁言和取消禁言
- App 管理员禁止指定群组中某些用户在一段时间内发言。
- App 管理员取消对某些用户的禁言。
- 被禁言用户退出群组之后再进入同一群组，禁言仍然有效。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
Private（即新版本中的 Work，好友工作群）类型不支持禁言。
使用示例：
List<String> membersAccount = Collections.singletonList("doocs");
+ForbidSendMsgRequest request = ForbidSendMsgRequest.builder()
+ .groupId("MyFirstGroup")
+ .membersAccount(membersAccount)
+ .muteTime(200L)
+ .build();
+
+ForbidSendMsgResult result = client.group.forbidSendMsg(request);
+获取被禁言群成员列表
App 管理员可以根据群组 ID 获取群组中被禁言的用户列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMutedAccountRequest request = new GetGroupMutedAccountRequest("MyFirstGroup");
+
+GetGroupMutedAccountResult result = client.group.getGroupMutedAccount(request);
+在群组中发送普通消息
App 管理员可以通过该接口在群组中发送普通消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("red packet");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendGroupMsgRequest request = SendGroupMsgRequest.builder()
+ .groupId("MyFirstGroup")
+ .random(1314)
+ .msgBody(msgBody)
+ .onlineOnlyFlag(OnlineOnlyFlag.YES)
+ .build();
+
+SendGroupMsgResult result = client.group.sendGroupMsg(request);
+在群组中发送系统通知
App 管理员可以通过该接口在群组中发送系统通知。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持，仅支持面向全员 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<String> toMembersAccount = Collections.singletonList("doocs");
+SendGroupSystemNotificationRequest request = SendGroupSystemNotificationRequest.builder()
+ .groupId("MyFirstGroup")
+ .content("hello world")
+ .toMembersAccount(toMembersAccount)
+ .build();
+
+SendGroupSystemNotificationResult result = client.group.sendGroupSystemNotification(request);
+转让群主
- App 管理员可以通过该接口将群主身份转移给他人。
- 没有群主的群，App 管理员可以通过此接口指定他人作为群主。
- 新群主必须为群内成员。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持（见说明） |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持转让群主，对该类型的群组进行操作时会返回 10007 错误。
使用示例：
ChangeGroupOwnerRequest request = ChangeGroupOwnerRequest.builder()
+ .groupId("MyFirstGroup")
+ .newOwnerAccount("doocs")
+ .build();
+
+ChangeGroupOwnerResult result = client.group.changeGroupOwner(request);
+撤回群消息
App 管理员通过该接口撤回指定群组的消息，消息需要在漫游有效期以内。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
List<MsgSeqItem> msgSeqList = Collections.singletonList(new MsgSeqItem(0L));
+GroupMsgRecallRequest request = GroupMsgRecallRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeqList(msgSeqList)
+ .build();
+
+GroupMsgRecallResult result = client.group.groupMsgRecall(request);
+导入群基础资料
App 管理员可以通过该接口导入群组，不会触发回调、不会下发通知； 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群组数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持导入群基础资料，对此类型的群组进行操作时会返回 10007 错误；如果需要达到导入群组基础资料的效果，可以通过 创建群组 和 修改群基础资料 的方式实现。
使用示例：
ImportGroupRequest request = ImportGroupRequest.builder()
+ .type(GroupType.PUBLIC)
+ .name("groupName")
+ .build();
+
+ImportGroupResult result = client.group.importGroup(request);
+导入群消息
- 该 API 接口的作用是导入群组的消息，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群消息数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）不支持导入群消息，对此类型的群组进行操作时会返回 10007 错误；因为此类型群组所适用的场景不支持查看入群前的历史消息，所以没有提供这一功能。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+GroupMsgItem item = GroupMsgItem.builder()
+ .fromAccount("doocs")
+ .sendTime(1628062005)
+ .msgBody(msgBody)
+ .build();
+List<GroupMsgItem> msgList = Collections.singletonList(item);
+ImportGroupMsgRequest request = ImportGroupMsgRequest.builder()
+ .groupId("newGroup")
+ .msgList(msgList)
+ .build();
+
+ImportGroupMsgResult result = client.group.importGroupMsg(request);
+导入群成员
- 该 API 接口的作用是导入群组成员，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群成员数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom（直播群）所适用的场景一般不需要导入成员，因此不支持导入群成员功能，对此类型的群组进行操作时会返回 10007 错误。
使用示例：
MemberItem item = MemberItem.builder()
+ .memberAccount("doocs")
+ .joinTime(1628062005)
+ .role(MemberRole.ADMIN)
+ .unreadMsgNum(1)
+ .build();
+List<MemberItem> members = Collections.singletonList(item);
+ImportGroupMemberRequest request = ImportGroupMemberRequest.builder()
+ .groupId("groupName")
+ .memberList(members)
+ .build();
+
+ImportGroupMemberResult result = client.group.importGroupMember(request);
+设置成员未读消息计数
- App 管理员使用该接口设置群组成员未读消息数，不会触发回调、不会下发通知。
- 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议设置群成员的未读消息计数。
说明
该文档仅限迁移用户使用，线上用户不能使用。
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
ChatRoom 和 AVChatroom（直播群）的客户端不支持未读消息计数，所以对这两种类型的群组成员设置未读消息计数是无效的（但是不会返回错误）。
使用示例：
SetUnreadMsgNumRequest result = SetUnreadMsgNumRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount("doocs")
+ .unreadMsgNum(1)
+ .build();
+
+SetUnreadMsgNumResult result = client.group.setUnreadMsgNum(request);
+删除指定用户发送的消息
该 API 接口的作用是撤回最近 1000 条消息中指定用户发送的消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
- AVChatRoom（直播群）不支持历史消息存储（此处撤回消息指撤回历史消息存储中的消息），对这此类型群组中的用户撤回消息是无效的（但是不会返回错误）。
- 该接口目前只支持静默撤回，在服务端对该消息打上撤回标记，并不会通知到客户端，只有拉漫游时才知道该消息被撤回。
使用示例：
DeleteGroupMsgBySenderRequest request = DeleteGroupMsgBySenderRequest.builder()
+ .groupId("MyFirstGroup")
+ .senderAccount("doocs")
+ .build();
+
+DeleteGroupMsgBySenderResult result = client.group.deleteGroupMsgBySender(request);
+拉取群历史消息
App 管理员可以通过该接口拉取群组的历史消息。
背景说明：
- 即时通信 IM 的群消息是按 Seq 排序的，按照 server 收到群消息的顺序分配 Seq，先发的群消息 Seq 小，后发的 Seq 大。
- 如果用户想拉取一个群的全量消息，首次拉取时不用填拉取 Seq，Server 会自动返回最新的消息，以后拉取时拉取 Seq 填上次返回的最小 Seq 减 1。
- 如果返回消息的 IsPlaceMsg 为 1，表示这个 Seq 的消息或者过期、或者存储失败、或者被删除了。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 不支持 |
| Community（社群） | 支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
AVChatRoom(直播群) 不支持历史消息存储，所以不支持调用此接口。
使用示例：
GroupMsgGetSimpleRequest request = GroupMsgGetSimpleRequest.builder()
+ .groupId("MyFirstGroup")
+ .reqMsgNumber(1)
+ .reqMsgNumber(20)
+ .build();
+
+GroupMsgGetSimpleResult result = client.group.groupMsgGetSimple(request);
+获取直播群在线人数
App 管理员可以根据群组 ID 获取直播群在线人数。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
注意
- 在线人数总体更新粒度为 10s。
- 当群人数大于等于 300 或群内有 Web 端用户的时候，出现群成员上下线或者进退群的时候，由于当前 10s 周期内已经统计了用户在线状态的原因，会在下一个 10s 周期才会统计到剔除状态用户变更的在线人数，所以会出现调用接口 10s - 20s 才会更新的现象。
- 当群人数小于 300 人且群内没有 Web 端用户的时候，用户进退群会触发即时更新在线人数。
使用示例：
GetOnlineMemberNumRequest request = new GetOnlineMemberNumRequest("MyFirstAVChatRoom");
+
+GetOnlineMemberNumResult result = client.group.getOnlineMemberNum(request);
+获取直播群在线列表
App 管理员可以根据群组 ID 获取直播群在线列表。
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。 :::
注意
- 此功能需 旗舰版套餐，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
- 在线列表总体更新粒度为 10s。
- 当直播群中超过 1000 人时，接口仅返回最新进群并且在线的 1000 人。
- 当群人数大于等于 300 或群内有 Web 端用户的时候，出现群成员上下线或者进退群的时候，由于当前 10s 周期内已经统计了用户在线状态的原因，会在下一个 10s 周期才会统计到剔除状态用户变更的在线人数，所以会出现调用接口 10s - 20s 才会更新的现象。
- 当群人数小于 300 人且群内没有 Web 端用户的时候，用户进退群会触发即时更新在线人数。
使用示例：
GetMembersRequest request = GetMembersRequest.builder()
+ .groupId("MyFirstGroup")
+ .timestamp(0)
+ .build();
+
+GetMembersResult result = client.group.getMembers(request);
+设置直播群成员标记
App 管理员和群主可以对直播群成员设置不同的标记以区分不同类型的群成员。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该 API 将返回失败。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupUserInfoRequest request = new ModifyGroupUserInfoRequest();
+request.setCommandType(1);
+GroupMemberItem item = new GroupMemberItem();
+item.setMarks(Arrays.asList(1001, 1002));
+item.setMemberAccount("test1");
+request.setMemberList(Collections.singletonList(item));
+request.setGroupId("MyFirstGroup");
+
+ModifyGroupUserInfoResult result = client.group.modifyGroupUserInfo(request);
+获取群自定义属性
App 管理员可以通过该接口获取群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupAttrRequest request = new GetGroupAttrRequest("MyFirstGroup");
+
+GetGroupAttrResult result = client.group.getGroupAttr(request);
+修改群自定义属性
App 管理员可以通过该接口修改群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GroupAttr groupAttr = new GroupAttr();
+groupAttr.setKey("isOpen");
+groupAttr.setValue("yes");
+List<GroupAttr> groupAttrs = Collections.singletonList(groupAttr);
+ModifyGroupAttrRequest request = ModifyGroupAttrRequest.builder()
+ .groupId("MyFirstGroup")
+ .groupAttrs(groupAttrs)
+ .build();
+
+ModifyGroupAttrResult result = client.group.modifyGroupAttr(request);
+清空群自定义属性
App 管理员可以通过该接口清空群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work（好友工作群） |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持 |
| Community | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ClearGroupAttrRequest request = new ClearGroupAttrRequest("MyFirstGroup");
+
+ClearGroupAttrResult result = client.group.clearGroupAttr(request);
+重置群自定义属性
App 管理员可以通过该接口重置群自定义属性。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持 |
| Public | 支持 |
| ChatRoom | 支持 |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
SetGroupAttrRequest request = new SetGroupAttrRequest();
+request.setGroupId("MyFirstGroup");
+GroupAttr groupAttr = new GroupAttr();
+groupAttr.setKey("isOpen");
+groupAttr.setValue("yes");
+List<GroupAttr> groupAttrs = Collections.singletonList(groupAttr);
+request.setGroupAttrs(groupAttrs);
+
+SetGroupAttrResult result = client.group.setGroupAttr(request);
+修改群聊历史消息
- 管理员修改群聊历史消息
- 可以单独修改消息中的 MsgBody 或 CloudCustomData 字段，也可以同时修改这两个字段。以请求中指定的字段值覆盖历史消息对应的字段。
- 不支持修改直播群的历史消息
注意
使用该接口修改消息后，被修改的消息不能恢复，请谨慎调用该接口。
使用示例：
ModifyGroupMsgRequest request = new ModifyGroupMsgRequest();
+request.setGroupId("MyFirstGroup");
+request.setMsgSeq(123L);
+TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+request.setMsgBody(msgBody);
+request.setMsgBody(msgBody);
+
+ModifyGroupMsgResult result = client.group.modifyGroupMsg(request);
+直播群广播消息
App 管理员可以通过该接口向所有直播群下发广播消息。
注意
直播群广播消息功能支持需要终端 SDK 6.5.2803 增强版及以上版本、Web SDK v2.21.0 及以上版本，需 购买旗舰版套餐包 并在 控制台>群功能配置>群功能配置>直播群广播消息 打开开关后方可使用。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 支持，发给所有直播群 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
SendBroadcastMsgRequest request = new SendBroadcastMsgRequest();
+request.setFromAccount("test1");
+TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+request.setMsgBody(msgBody);
+request.setRandom(1223L);
+
+SendBroadcastMsgResult result = client.group.sendBroadcastMsg(request);
+拉取群消息已读回执信息
App 管理员可以通过该接口拉取群消息已读回执信息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work(好友工作群) |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 不支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMsgReceiptRequest request = new GetGroupMsgReceiptRequest();
+request.setGroupId("MyFirstGroup");
+MsgSeqItem seqItem = new MsgSeqItem();
+seqItem.setMsgSeq(123L);
+request.setMsgSeqList(Collections.singletonList(seqItem));
+
+GetGroupMsgReceiptResult result = client.group.getGroupMsgReceipt(request);
+拉取群消息已读回执详情
App 管理员可以通过该接口拉取群消息已读或未读成员列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 支持，同新版本中的 Work(好友工作群) |
| Public | 支持 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）） |
| AVChatRoom | 不支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupMsgReceiptDetailRequest request = new GetGroupMsgReceiptDetailRequest();
+request.setGroupId("MyFirstGroup");
+request.setMsgSeq(123L);
+request.setNum(12);
+request.setCursor("");
+request.setFlag(12);
+
+GetGroupMsgReceiptDetailResult result = client.group.getGroupMsgReceiptDetail(request);
+创建话题
App 管理员可以通过该接口创建话题。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
CreateGroupTopicRequest request = new CreateGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFaceUrl("");
+
+CreateGroupTopicResult result = client.group.createGroupTopic(request);
+获取话题资料
App 管理员可以通过该接口获取话题资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupTopicRequest request = new GetGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setFromAccount("1400187352");
+
+GetGroupTopicResult result = client.group.getGroupTopic(request);
+修改话题资料
App 管理员可以通过该接口修改话题资料。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ModifyGroupTopicRequest request = new ModifyGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFaceUrl("");
+
+ModifyGroupTopicResult result = client.group.modifyGroupTopic(request);
+导入话题基础资料
App 管理员可以通过该接口导入话题，不会触发回调、不会下发通知；当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量话题数据。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
ImportGroupTopicRequest request = new ImportGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+request.setTopicName("test");
+request.setFromAccount("123");
+
+ImportGroupTopicResult result = client.group.importGroupTopic(request);
+解散话题
App 管理员可以通过该接口解散话题。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持 |
| Public | 不支持 |
| ChatRoom | 不支持 |
| AVChatRoom | 不支持 |
| Community（社群） | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
DestroyGroupTopicRequest request = new DestroyGroupTopicRequest();
+request.setGroupId("MyFirstGroup");
+
+DestroyGroupTopicResult result = client.group.destroyGroupTopic(request);
+获取封禁群成员列表
App 管理员可以通过该接口获取对应直播群的封禁成员列表。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
GetGroupBanMemberRequest request = new GetGroupBanMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setLimit(10);
+request.setOffset(0);
+
+GetGroupBanMemberResult result = client.group.getGroupBanMember(request);
+群成员封禁
App 管理员可以通过该接口向直播群封禁成员，封禁后成员无法接收消息，并且封禁时间内无法再次进群。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
BanGroupMemberRequest request = new BanGroupMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setDuration(1000L);
+request.setMembersAccount(Arrays.asList("test1", "bingo"));
+request.setDescription("test");
+
+BanGroupMemberResult result = client.group.banGroupMember(request);
+群成员解封
App 管理员可以通过该接口向直播群解封成员，解封后，之前封禁的成员可重新进群获取消息。
说明
适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
|---|---|
| Private | 不支持，同新版本中的 Work（好友工作群） |
| Public | 不支持 |
| ChatRoom | 不支持，同新版本中的 Meeting（临时会议群） |
| AVChatRoom | 支持 |
| Community（社群） | 不支持 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
使用示例：
UnbanGroupMemberRequest request = new UnbanGroupMemberRequest();
+request.setGroupId("MyFirstGroup");
+request.setMembersAccount(Arrays.asList("test1", "bingo"));
+
+UnbanGroupMemberResult result = client.group.unbanGroupMember(request);
+拉取群消息扩展
App 管理员和群成员可以拉取消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条群消息可设置的最大键值对数量为 300 条。
- 被设置的群消息需要在发送时指定“支持消息扩展”，参见 在群组中发送普通消息。
使用示例：
GroupGetKeyValuesRequest request = GroupGetKeyValuesRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeq(1L)
+ .build();
+
+GroupGetKeyValuesResult result = client.group.groupGetKeyValues(request);
+设置群消息扩展
App 管理员和群成员可以为群聊普通消息设置消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条群消息可设置的最大键值对数量为 300 条。
- 被设置的群消息需要在发送时指定“支持消息扩展”，参见 在群组中发送普通消息。
使用示例：
GroupSetKeyValuesRequest request = GroupSetKeyValuesRequest.builder()
+ .groupId("MyFirstGroup")
+ .msgSeq(1L)
+ .extensionList(Collections.singletonList(KeyValueSeq.builder()
+ .key("test")
+ .value("test")
+ .build()))
+ .build();
+
+GroupSetKeyValuesResult result = client.group.groupSetKeyValues(request);
+获取群计数器
App 管理员可以通过该接口获取群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
GetGroupCounterRequest request = GetGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+GetGroupCounterResult result = client.group.getGroupCounter(request);
+更新群计数器
App 管理员可以通过该接口更新（设置、递增、递减）群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
List<GroupCounterItem> groupCounter = new ArrayList<>();
+GroupCounterItem item = new GroupCounterItem();
+item.setKey("x");
+item.setValue(1L);
+groupCounter.add(item);
+UpdateGroupCounterRequest request = UpdateGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .groupCounter(groupCounter)
+ .mode(GroupCounterMode.SET)
+ .build();
+
+UpdateGroupCounterResult result = client.group.updateGroupCounter(request);
+删除群计数器
App 管理员可以通过该接口删除群计数器。
注意
- 该功能仅对旗舰版客户开放，需 购买旗舰版套餐包。
使用示例：
DeleteGroupCounterRequest request = DeleteGroupCounterRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+DeleteGroupCounterResult result = client.group.deleteGroupCounter(request);
+设置/取消直播群管理员
App 管理员可以为直播群设置和取消管理员，当设置管理员时，被设置的账号可以不需要在直播群里，被设置为管理员之后，该账号即使离开直播群再重新进群也仍然是管理员。需要取消管理员身份时，需要调用本接口取消该用户的管理员身份。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。
使用示例：
ModifyAdminRequest request = ModifyAdminRequest.builder()
+ .groupId("MyFirstGroup")
+ .commandType(1)
+ .adminAccount(Arrays.asList("test1", "bingo"))
+ .build();
+
+ModifyAdminResult result = client.group.modifyAdmin(request);
+获取直播群管理员列表
App 管理员可以根据群组 ID 获取直播群管理员列表。该功能仅限旗舰版用户在 IM 控制台“群功能配置”中开启“直播群在线成员列表”后方可使用。
使用示例：
GetAdminListRequest request = GetAdminListRequest.builder()
+ .groupId("MyFirstGroup")
+ .build();
+
+GetAdminListResult result = client.group.getAdminList(request);
+查询用户是否在直播群内
App 管理员可以根据群组 ID 查询一批用户是否在直播群内。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。
使用示例：
CheckMembersRequest request = CheckMembersRequest.builder()
+ .groupId("MyFirstGroup")
+ .memberAccount(Arrays.asList("test1", "bingo"))
+ .build();
+
+CheckMembersResult result = client.group.checkMembers(request);
+介绍
本文档基于腾讯云 IM Server SDK Java v0.4.10 编写。
前提条件
已登录 即时通信 IM 控制台 并创建了应用。创建完成后，可以拿到
sdkAppId以及key。已创建 App 管理员账号
userId，也即identifier。
说明
“App 管理员”是对 App 具有最高管理权限的角色，可调用 REST API 接口，进行创建/解散群组、发送全员推送消息等操作。每个应用最多支持配置 10 个管理员。
SDK 环境依赖
- Java 8 及以上版本
- Maven
SDK 源码
SDK 源码请参见 GitHub。
项目贡献者
全员推送
全员推送
全员推送，用户运营利器，不仅支持全员发送特定内容，还可根据标签、属性，针对特定用户群体发送个性化内容，如会员活动、区域通知等，助力拉新、转化、促活等各个阶段运营工作的有效进行。
- 支持全员推送。
- 支持按用户属性推送。
- 支持按用户标签推送。
- 管理员推送消息，接收方看到消息发送者是管理员。
- 管理员指定某一账号向其他账号推送消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 支持消息离线存储，不支持漫游。
- 由于全员推送需要下发的账号数量巨大，下发完全部账号需要一定时间（根据账号总数而定，一般在一分钟内）。
- 支持只推在线用户，需要将 MsgLifeTime 参数设置为 0。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hi, beauty");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ImPushRequest request = ImPushRequest.builder()
+ .msgRandom(9312457L)
+ .msgBody(msgBody)
+ .fromAccount("admin")
+ .msgLifeTime(120)
+ .build();
+
+ImPushResult result = client.member.imPush(request);
+设置应用属性名称
每个应用可以设置自定义的用户属性，最多可以有 10 个。通过本接口可以设置每个属性的名称，设置完成后，即可用于按用户属性推送等。
使用示例：
Map<String, String> attrNames = new HashMap<>(3);
+attrNames.put("0", "sex");
+attrNames.put("1", "city");
+attrNames.put("2", "country");
+ImSetAttrNameRequest request = new ImSetAttrNameRequest(attrNames);
+
+ImSetAttrNameResult result = client.member.imSetAttrName(request);
+获取应用属性名称
管理员获取应用属性名称。使用前请先 设置应用属性名称 。
使用示例：
ImGetAttrNameRequest request = new ImGetAttrNameRequest();
+
+ImGetAttrNameResult result = client.member.imGetAttrName(request);
+获取用户属性
获取用户属性（必须以管理员账号调用）；每次最多只能获取 100 个用户的属性。使用前请先 设置应用属性名称 。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImGetAttrRequest request = new ImGetAttrRequest(toAccount);
+
+ImGetAttrResult result = client.member.imGetAttr(request);
+设置用户属性
管理员给用户设置属性。每次最多只能给 100 个用户设置属性。使用前请先 设置应用属性名称 。
使用示例：
Map<String, Object> attrs = new HashMap<>();
+attrs.put("sex", "attr1");
+attrs.put("city", "attr2");
+UserAttrItem item = new UserAttrItem("test1", attrs);
+List<UserAttrItem> userAttrs = Collections.singletonList(item);
+ImSetAttrRequest request = new ImSetAttrRequest(userAttrs);
+
+ImSetAttrResult result = client.member.imSetAttr(request);
+删除用户属性
管理员给用户删除属性。注意每次最多只能给 100 个用户删除属性。使用前请先 设置应用属性名称 。
使用示例：
Map<String, Object> attrs = new HashMap<>();
+attrs.put("sex", "attr1");
+attrs.put("city", "attr2");
+UserAttrItem item = UserAttrItem.builder()
+ .toAccount("test1")
+ .attrs(attrs)
+ .build();
+List<UserAttrItem> userAttrs = Collections.singletonList(item);
+ImRemoveAttrRequest request = new ImRemoveAttrRequest(userAttrs);
+
+ImRemoveAttrResult result = client.member.imRemoveAttr(request);
+获取用户标签
获取用户标签（必须以管理员账号调用）。每次最多只能获取 100 个用户的标签。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImGetTagRequest request = new ImGetTagRequest(toAccount);
+
+ImGetTagResult result = client.member.imGetTag(request);
+添加用户标签
管理员给用户添加标签。
注意
- 每次请求最多只能给 100 个用户添加标签，请求体中单个用户添加标签数最多为 10 个。
- 单个用户可设置最大标签数为 100 个，若用户当前标签超过 100，则添加新标签之前请先删除旧标签。
- 单个标签最大长度为 50 字节。
使用示例：
List<String> tags = Arrays.asList("a", "b");
+UserTagItem item = UserTagItem.builder()
+ .toAccount("test1")
+ .tags(tags)
+ .build();
+List<UserTagItem> userTags = Collections.singletonList(item);
+ImAddTagRequest request = new ImAddTagRequest(userTags);
+
+ImAddTagResult result = client.member.imAddTag(request);
+删除用户标签
管理员给用户删除标签。注意每次最多只能给 100 个用户删除标签。
使用示例：
List<String> tags = Arrays.asList("a", "b");
+UserTagItem item = UserTagItem.builder()
+ .toAccount("test1")
+ .tags(tags)
+ .build();
+List<UserTagItem> userTags = Collections.singletonList(item);
+ImRemoveTagRequest request = new ImRemoveTagRequest(userTags);
+
+ImRemoveTagResult result = client.member.imRemoveTag(request);
+删除所有用户标签
管理员给用户删除所有标签。注意每次最多只能给 100 个用户删除所有标签。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+ImRemoveAllTagsRequest request = new ImRemoveAllTagsRequest(toAccount);
+
+ImRemoveAllTagsResult result = client.member.imRemoveAllTags(request);
+单聊消息
单发单聊消息
- 管理员向账号发消息，接收方看到消息发送者是管理员。
- 管理员指定某一账号向其他账号发消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 该接口不会检查发送者和接收者的好友关系（包括黑名单），同时不会检查接收者是否被禁言。
- 该接口默认不会检查接收者对发送者是否设置了免打扰，如需检查，请在"SendMsgControl"字段填上"WithMuteNotifications"。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendMsgRequest request = SendMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .msgRandom(123L)
+ .msgBody(msgBody)
+ .syncOtherMachine(SyncOtherMachine.YES)
+ .msgTimeStamp(1631934058)
+ .msgLifeTime(604800)
+ .build();
+
+SendMsgResult result = client.message.sendMsg(request);
+批量发单聊消息
- 支持一次对最多 500 个用户进行单发消息。
- 与单发消息相比，该接口更适用于营销类消息、系统通知 tips 等时效性较强的消息。
- 若消息不需要计入未读数，也不需要存储聊天记录，则可将 MsgLifeTime 字段设置为 0，这样可以带来更快的消息下发速度。
- 管理员指定某一账号向目标账号批量发消息，接收方看到发送者不是管理员，而是管理员指定的账号。
- 该接口不触发回调请求。
- 该接口不会检查发送者和接收者的好友关系（包括黑名单），同时不会检查接收者是否被禁言。
- 该接口默认不会检查接收者对发送者是否设置了免打扰，如需检查，请在"SendMsgControl"字段填上"WithMuteNotifications"。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
List<String> toAccount = Arrays.asList("test1", "test2");
+TIMTextMsgElement msg = new TIMTextMsgElement("hi bingo");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+BatchSendMsgRequest request = BatchSendMsgRequest
+ .builder()
+ .toAccount(toAccount)
+ .msgRandom(123L)
+ .msgBody(msgBody)
+ .syncOtherMachine(SyncOtherMachine.NO)
+ .msgSeq(28460L)
+ .build();
+
+BatchSendMsgResult result = client.message.batchSendMsg(request);
+导入单聊消息
- 导入历史单聊消息到即时通信 IM。
- 平滑过渡期间，将原有即时通信实时单聊消息导入到即时通信 IM。
- 该接口会更新会话。
- 该接口不会触发回调。
- 对于同一个单聊会话的消息，该接口会根据 MsgSeq ， MsgRandom ， MsgTimeStamp 字段的值对导入的消息进行去重。仅当这三个字段的值都对应相同时，才判定消息是重复的，消息是否重复与消息内容本身无关。 另外，若两条消息的 MsgSeq ， MsgRandom ， MsgTimeStamp 字段对应相同，而 from_account 和 to_account 相反，则这两条消息也认为是重复的。
- 重复导入的消息不会覆盖之前已导入的消息（即消息内容以首次导入的为准）。
- 单聊消息 MsgSeq 字段的作用及说明：该字段在发送消息时由用户自行指定，该值可以重复，非后台生成，非全局唯一。与群聊消息的 MsgSeq 字段不同，群聊消息的 MsgSeq 由后台生成，每个群都维护一个 MsgSeq，从 1 开始严格递增。单聊消息历史记录对同一个会话的消息先以时间戳排序，同秒内的消息再以 MsgSeq 排序。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello bingo");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ImportMsgRequest request = ImportMsgRequest.builder()
+ .fromAccount("bingo")
+ .toAccount("test1")
+ .msgRandom(122L)
+ .msgTimeStamp(1557387418)
+ .msgBody(msgBody)
+ .build();
+
+ImportMsgResult result = client.message.importMsg(request);
+查询单聊消息
- 管理员按照时间范围查询某单聊会话的消息记录。
- 查询的单聊会话由请求中的 From_Account 和 To_Account 指定。查询结果包含会话双方互相发送的消息，具体每条消息的发送方和接收方由每条消息里的 From_Account 和 To_Account 指定。
- 一般情况下，请求中的 From_Account 和 To_Account 字段值互换，查询结果不变。但通过 单发单聊消息 或 批量发单聊消息 接口发送的消息，如果指定 SyncOtherMachine 值为 2，则需要指定正确的 From_Account 和 To_Account 字段值才能查询到该消息。 例如，通过 单发单聊消息 接口指定账号 A 给账号 B 发一条消息，同时指定 SyncOtherMachine 值为 2。则调用本接口时，From_Account 必须设置为账号 B，To_Account 必须设置为账号 A 才能查询到该消息。
- 查询结果包含被撤回的消息，由消息里的 MsgFlagBits 字段标识。
- 若想通过 撤回单聊消息 接口撤回某条消息，可先用本接口查询出该消息的 MsgKey，然后再调用撤回接口进行撤回。
- 可查询的消息记录的时间范围取决于漫游消息存储时长，默认是 7 天。支持在控制台修改消息漫游时长，延长消息漫游时长是增值服务。具体请参考 漫游消息存储。
- 若请求时间段内的消息总大小超过应答包体大小限制（目前为 13K）时，则需要续拉。您可以通过应答中的 Complete 字段查看是否已拉取请求的全部消息。
使用示例：
AdminGetRoamMsgRequest request = AdminGetRoamMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .maxCnt(123)
+ .minTime(1631934000)
+ .maxTime(1631934060)
+ .build();
+
+AdminRoamMsgResult result = client.message.getRoamMsg(request);
+
+List<MsgListItem> msgList = result.getMsgList();
+if (msgList != null && msgList.size() > 0) {
+ for (MsgListItem item : msgList) {
+ List<TIMMsgElement> msgBody = item.getMsgBody();
+ if (msgBody != null && msgList.size() > 0) {
+ for (TIMMsgElement msgElement : msgBody) {
+ // 根据 msgType 强转为对应的子类
+ if (Objects.equals(msgElement.getMsgType(), MsgType.TIM_CUSTOM_ELEM)) {
+ TIMCustomMsgElement t = (TIMCustomMsgElement) msgElement;
+ System.out.println(t.getMsgContent().getDesc());
+ } else if (Objects.equals(msgElement.getMsgType(), MsgType.TIM_TEXT_ELEM)) {
+ TIMTextMsgElement t = (TIMTextMsgElement) msgElement;
+ System.out.println(t.getMsgContent().getText());
+ }
+ }
+ }
+ }
+}
+撤回单聊消息
- 管理员撤回单聊消息。
- 该接口可以撤回所有单聊消息，包括客户端发出的单聊消息，由 单发 和 批量发 接口发出的单聊消息。
- 若需要撤回由客户端发出的单聊消息，您可以开通 发单聊消息之前回调 或 发单聊消息之后回调 ，通过该回调接口记录每条单聊消息的 MsgKey ，然后填在本接口的 MsgKey 字段进行撤回。您也可以通过 查询单聊消息 查询出待撤回的单聊消息的 MsgKey 后，填在本接口的 MsgKey 字段进行撤回。
- 若需要撤回由 单发 和 批量发 接口发出的单聊消息，需要记录这些接口回包里的 MsgKey 字段以进行撤回。
- 调用该接口撤回消息后，该条消息的离线、漫游存储，以及消息发送方和接收方的客户端的本地缓存都会被撤回。
- 该接口可撤回的单聊消息没有时间限制，即可以撤回任何时间的单聊消息。
注意
使用该接口撤回单聊消息后，被撤回的消息不能恢复，请谨慎调用该接口。
使用示例：
AdminMsgWithdrawRequest request = AdminMsgWithdrawRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("31906_833502_1572869830")
+ .build();
+
+AdminMsgWithdrawResult result = client.message.msgWithdraw(request);
+设置单聊消息已读
- 设置用户的某个单聊会话的消息已读。
使用示例：
AdminSetMsgReadRequest request = AdminSetMsgReadRequest.builder()
+ .reportAccount("test1")
+ .peerAccount("test2")
+ .build();
+
+AdminSetMsgReadResult result = client.message.setMsgRead(request);
+查询单聊未读消息计数
App 后台可以通过该接口查询特定账号的单聊总未读数（包含所有的单聊会话）或者单个单聊会话的未读数。
使用示例：
GetC2cUnreadMsgRequest request = new GetC2cUnreadMsgRequest("test2");
+List<String> peerAccount = Arrays.asList("test1", "bingo");
+request.setPeerAccount(peerAccount);
+
+C2cUnreadMsgNumResult result = client.message.getC2cUnreadMsgNum(request);
+修改单聊历史消息
- 管理员修改单聊历史消息。
- 可以单独修改消息中的 MsgBody 或 CloudCustomData 字段，也可以同时修改这两个字段。以请求中指定的字段值覆盖历史消息对应的字段。
- 待修改的单聊消息的 MsgKey 可通过以下方式获取：
注意
使用该接口修改消息后，被修改的消息不能恢复，请谨慎调用该接口。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("test modify c2c msg");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+ModifyC2cMsgRequest request = ModifyC2cMsgRequest.builder()
+ .fromAccount("test1")
+ .toAccount("test2")
+ .msgKey("1353691732_123_1653995506")
+ .msgBody(msgBody)
+ .build();
+
+ModifyC2cMsgResult result = client.message.modifyC2cMsg(request);
+拉取单聊消息扩展
App 管理员和会话成员可以拉取消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条单聊消息可设置的最大键值对数量为 300 条。
- 被设置的单聊消息需要在发送时指定“支持消息扩展”，参见 单发单聊消息。
使用示例：
GetKeyValuesRequest request = GetKeyValuesRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("1353691732_123_1653995506")
+ .startSeq(1L)
+ .build();
+
+GetKeyValuesResult result = client.message.getKeyValues(request);
+设置单聊消息扩展
App 管理员和会话成员可以为单聊普通消息设置消息扩展，消息扩展为一组自定义的键值对。
注意
- 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
- 单条单聊消息可设置的最大键值对数量为 300 条。
- 被设置的单聊消息需要在发送时指定“支持消息扩展”，参见 单发单聊消息。
使用示例：
SetKeyValuesRequest request = SetKeyValuesRequest.builder()
+ .fromAccount("test1")
+ .toAccount("bingo")
+ .msgKey("1353691732_123_1653995506")
+ .build();
+
+SetKeyValuesResult result = client.message.setKeyValues(request);
+单向删除单聊历史消息
- App 管理员调用该接口单向删除一个单聊会话的多条消息。
- 只能以消息的发送方或接收方的身份去删除单聊会话的历史消息。
- 只能单向删除（以会话其中一方的身份去删除某条消息后，自己看不到这条消息，会话的对方仍然可以看到这条消息）
使用示例：
DeleteC2cMsgRambleRequest request = DeleteC2cMsgRambleRequest.builder()
+ .operatorAccount("test1")
+ .peerAccount("test2")
+ .msgKeyList(Collections.singletonList("1353691732_123_1653995506"))
+ .build();
+
+DeleteC2cMsgRambleResult result = client.message.deleteC2cMsgRamble(request);
+清空群聊历史消息
该 API 接口的作用是清空群聊中用户发送的历史消息。
此接口通过打标记实现 SDK 无法拉取的效果，并没有真的执行删除操作，Admin 用户仍然可以通过“拉取群聊历史消息”接口拉取已清空的历史消息。
使用示例：
ClearGroupMsgRequest request = ClearGroupMsgRequest.builder()
+ .groupId("test_group")
+ .msgSeq(123L)
+ .build();
+
+ClearGroupMsgResult result = client.message.clearGroupMsg(request);
+公众号管理
创建公众号
App 管理员可以通过该接口创建公众号。
使用示例：
CreateOfficialAccountRequest request = new CreateOfficialAccountRequest();
+request.setOwnerAccount("test");
+request.setName("test_official_account");
+
+CreateOfficialAccountResult result = client.officialAccount.createOfficialAccount(request);
+销毁公众号
App 管理员可以通过该接口销毁公众号。
使用示例：
DestroyOfficialAccountRequest request = new DestroyOfficialAccountRequest();
+request.setOfficialAccount("test_official_account_user_id");
+
+DestroyOfficialAccountResult result = client.officialAccount.destroyOfficialAccount(request);
+修改公众号资料
App 管理员可以通过该接口修改公众号的相关信息，如公众号的名称、头像、简介等
使用示例：
ModifyOfficialAccountBaseInfoRequest request = new ModifyOfficialAccountBaseInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setName("test_official_account2");
+
+ModifyOfficialAccountBaseInfoResult result = client.officialAccount.modifyOfficialAccountBaseInfo(request);
+获取公众号详细资料
App 管理员可以通过该接口获取公众号的相关资料信息。
使用示例：
GetOfficialAccountInfoRequest request = new GetOfficialAccountInfoRequest();
+request.setOfficialAccountIdList(Collections.singletonList(new OfficialAccountItem("test_official_account_user_id")));
+
+GetOfficialAccountInfoResult result = client.officialAccount.getOfficialAccountInfo(request);
+获取公众号的订阅成员资料
App 管理员可以通过该接口获取订阅某个公众号的所有用户信息.
使用示例：
GetSubscriberInfoRequest request = new GetSubscriberInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setLimit(10);
+request.setNext("");
+
+GetSubscriberInfoResult result = client.officialAccount.getSubscriberInfo(request);
+添加订阅者
App 管理员可以通过该接口使用户订阅某个公众号，成为公众号的订阅成员。
使用示例：
AddSubscriberRequest request = new AddSubscriberRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberList(Collections.singletonList(new OfficialAccountItem("test_subscriber_id")));
+
+AddSubscriberResult result = client.officialAccount.addSubscriber(request);
+删除订阅者
App 管理员可以通过该接口使用户取消订阅某个公众号，从公众号的订阅成员中移除。
使用示例：
DeleteSubscriberRequest request = new DeleteSubscriberRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberToDelAccount(Collections.singletonList("test_subscriber_id"));
+
+DeleteSubscriberResult result = client.officialAccount.deleteSubscriber(request);
+修改订阅者资料
App 管理员可以通过该接口修改订阅者的相关资料信息。
使用示例：
ModifySubscriberInfoRequest request = new ModifySubscriberInfoRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setSubscriberAccount("test_subscriber_id");
+request.setCustomString("test_custom_string");
+
+ModifySubscriberInfoResult result = client.officialAccount.modifySubscriberInfo(request);
+获取订阅的公众号列表
App 管理员可以通过该接口获取用户订阅的所有公众号列表信息。
使用示例：
GetSubscribedOfficialAccountListRequest request = new GetSubscribedOfficialAccountListRequest();
+request.setSubscriberAccount("test_subscriber_id");
+
+GetSubscribedOfficialAccountListResult result = client.officialAccount.getSubscribedOfficialAccountList(request);
+公众号用户发送广播消息
- App 管理员可以通过该接口向关注公众号的所有订阅者发送普通消息。
- 单个公众号的发送频率上限为1条/秒，每小时最多可发布2条广播消息。
- 如果5分钟内两条消息的内容相同，后面的消息将被当做重复消息而丢弃。
使用示例：
TIMTextMsgElement msg = new TIMTextMsgElement("hello world");
+List<TIMMsgElement> msgBody = Collections.singletonList(msg);
+SendOfficialAccountMsgRequest request = SendOfficialAccountMsgRequest.builder()
+ .officialAccount("test_official_account_user_id")
+ .random(123)
+ .msgBody(msgBody)
+ .build();
+
+SendOfficialAccountMsgResult result = client.officialAccount.sendOfficialAccountMsg(request);
+拉取公众号用户历史消息
- 即时通信 IM 的公众号消息是按 Seq 排序的，按照 server 收到公众号消息的顺序分配 Seq，先发的公众号消息 Seq 小，后发的 Seq 大。
- 即时通信 IM 会给每条公众号消息生成一个 MsgKey，格式为 "Seq_1_ServerTime"。
- 如果用户想拉取一个公众号的全量消息，需要填写消息的 LastMsgKey，首次拉取时不用填拉取 LastMsgKey，Server 会自动返回最新的消息，以后拉取时拉取 LastMsgKey 填上次请求返回 LastMsgKey。
- 如果返回消息的 IsPlaceMsg 为1，表示这个 Seq 的消息或者过期、或者存储失败、或者被删除了。
使用示例：
OfficialAccountMsgGetSimpleRequest request = new OfficialAccountMsgGetSimpleRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setLastMsgKey("msg_key");
+request.setReqMsgNumber(10);
+request.setWithRecalledMsg(1);
+
+OfficialAccountMsgGetSimpleResult result = client.officialAccount.msgGetSimple(request);
+撤回公众号消息
- 管理员撤回公众号消息。
- 该接口可以撤回所有漫游有效期内的公众号消息，包括客户端发出的公众号消息，由 REST API 接口发出的公众号消息。
- 若需要撤回由客户端发出的公众号消息，您可以开通 发公众号消息之后回调 ，通过该回调接口记录每条公众号消息的 MsgKey，然后填在本接口的 MsgKeyList 参数里进行撤回。您也可以通过 拉取公众号用户历史消息 查询出待撤回的公众号消息的相关信息后，使用本接口进行撤回。
- 若需要撤回由 REST API 公众号用户发送广播消息 接口发出的公众号消息，需要记录这些接口回包里的 MsgKey 字段以进行撤回。
- 调用该接口撤回消息后，该条消息的接收方的客户端的本地缓存都会被撤回。
- 该接口可撤回的公众号消息没有时间限制，即可以撤回任何时间的公众号消息，但是公众号消息的漫游时间需要在有效期内。
使用示例：
OfficialAccountMsgRecallRequest request = new OfficialAccountMsgRecallRequest();
+request.setOfficialAccount("test_official_account_user_id");
+request.setMsgKeyList(Collections.singletonList("msg_key"));
+
+OfficialAccountMsgRecallResult result = client.officialAccount.msgRecall(request);
+全局禁言管理
设置全局禁言
- 设置账号的单聊消息全局禁言。
- 设置账号的群组消息全局禁言。
使用示例：
SetNoSpeakingRequest request = SetNoSpeakingRequest.builder()
+ .setAccount("test1")
+ .msgNoSpeakingTime(NoSpeakingTime.NEVER)
+ .groupMsgNoSpeakingTime(NoSpeakingTime.FOREVER)
+ .build();
+
+SetNoSpeakingResult result = client.operation.setNoSpeaking(request);
+查询全局禁言
- 查询账号的单聊消息全局禁言。
- 查询账号的群组消息全局禁言。
使用示例：
GetNoSpeakingRequest request = new GetNoSpeakingRequest("test1");
+
+GetNoSpeakingResult result = client.operation.getNoSpeaking(request);
+运营管理
拉取运营数据
App 管理员可以通过该接口拉取最近 30 天的运营数据，可拉取的字段见下文可拉取的运营字段。
使用示例：
GetAppInfoRequest request = new GetAppInfoRequest();
+List<String> requestFields = Arrays.asList("ChainIncrease", "ChainDecrease");
+request.setRequestField(requestFields);
+
+GetAppInfoResult result = client.operation.getAppInfo(request);
+下载最近消息记录
App 管理员可以通过该接口获取 App 中最近 7 天中某天某小时的所有单发或群组消息记录的下载地址。
注意
- 下载消息记录里的图片、语音、文件和短视频，此功能仅适用于 4.X 版本 IM SDK，可通过聊天记录中的 URL 字段进行下载。如您使用 2.X 或 3.X 版本的 IM SDK，您将无法通过该方法获取到以上信息，如您需要此功能，请您升级至 4.X 版本。
- 消息记录以日志文件形式保存并使用 GZip 压缩，通过该接口获取到下载地址后，请自行下载并处理；消息记录文件每小时产生一次，例如 0 点（00:00~00:59）的数据在 01:00 后开始处理，一般 1 小时内处理完毕（消息较多则处理时间较长）；文件有效期 7 天，无论是否下载过，都会在 7 天后删除，被删除后不支持重新导出；获取到的下载地址存在有效期，请在过期前进行下载，若地址失效，请通过该接口重新获取。
- 此接口仅用于下载最近 7 天的聊天记录文件，用于备份或数据统计等。不建议使用该接口用于线上实时业务。
使用示例：
GetHistoryRequest request = GetHistoryRequest.builder()
+ .chatType(ChatType.C2C)
+ .msgTime("2015120121")
+ .build();
+
+GetHistoryResult result = client.operation.getHistory(request);
+获取服务器 IP 地址
基于安全等考虑，您可能需要获知服务器的 IP 地址列表，以便进行相关限制。App 管理员可以通过该接口获得 SDK、第三方回调所使用到的服务器 IP 地址列表或 IP 网段信息。
注意
此接口仅支持获取中国大陆地区的所有 IM 接入方式的 IP 地址或 IP 网段信息。
使用示例：
GetIpListRequest request = new GetIpListRequest();
+
+GetIpListResult result = client.op~eration.getIpList(request);
+聊天文件封禁
本接口用于封禁聊天消息中的富媒体文件。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
使用示例：
ForbidIllegalObjectRequest request = ForbidIllegalObjectRequest.builder()
+ .rawUrl("https://cos.ap-shanghai.myqcloud.com/005f-shanghai-360-shared-01-1256635546/76aa-1400152839/2f3b-2273451635034382/699eb4ee5ffa9aeb70627958766f2927-142072.jpg")
+ .build();
+
+ForbidIllegalObjectResult result = client.operation.forbidIllegalObject(request);
+聊天文件解封
本接口用于解封聊天消息中的富媒体文件。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
AllowBannedObjectRequest request = AllowBannedObjectRequest.builder()
+ .rawUrl("https://cos.ap-shanghai.myqcloud.com/005f-shanghai-360-shared-01-1256635546/76aa-1400152839/2f3b-2273451635034382/699eb4ee5ffa9aeb70627958766f2927-142072.jpg")
+ .build();
+
+AllowBannedObjectResult result = client.operation.allowBannedObject(request);
+聊天文件签名
本接口用于获取聊天消息中的富媒体文件 FULL_CONTROL 权限的 URL 签名以及文件状态信息，默认有效期 15 分钟。一般 SDK 下发的文件 URL 为普通账号签名，违规封禁后，可以使用 FULL_CONTROL 权限的 URL 签名来查看封禁的资源。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至 4.9.x 版本及以上，Web SDK 更新至 v2.0.0 版本及以上。
RawUrlItem item = new RawUrlItem();
+item.setRawUrl("https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc6.png");
+item.setResourceId(1);
+List<RawUrlItem> rawUrls = Collections.singletonList(item);
+GetCosSigRequest request = GetCosSigRequest.builder()
+ .rawUrls(rawUrls)
+ .build();
+
+GetCosSigResult result = client.operation.getCosSig(request);
+资料管理
设置资料
使用示例：
ProfileItem profileItem = ProfileItem.builder()
+ .tag(TagProfile.IM_NICK)
+ .value("MyNickName")
+ .build();
+List<ProfileItem> profiles = Collections.singletonList(profileItem);
+PortraitSetRequest request = PortraitSetRequest.builder()
+ .fromAccount("test1")
+ .profileItemList(profiles)
+ .build();
+
+PortraitSetResult result = client.profile.portraitSet(request);
+拉取资料
- 支持拉取好友和非好友的资料字段。
- 支持拉取 标配资料字段 和 自定义资料字段。
- 建议每次拉取的用户数不超过 100，避免因回包数据量太大导致回包失败。
- 请确保请求中的所有账号都已导入即时通信 IM，如果请求中含有未导入即时通信 IM 的账号，即时通信 IM 后台将会提示错误。
使用示例：
List<String> tagList = Collections.singletonList(TagProfile.IM_NICK);
+List<String> toAccount = Collections.singletonList("test1");
+PortraitGetRequest request = PortraitGetRequest.builder()
+ .tagList(tagList)
+ .toAccount(toAccount)
+ .build();
+
+PortraitGetResult result = client.profile.portraitGet(request);
+快速上手
安装
Maven
在项目的 pom.xml 的 dependencies 中引入以下依赖:
<dependency>
+ <groupId>io.github.doocs</groupId>
+ <artifactId>im-server-sdk-java</artifactId>
+ <version>0.4.10</version>
+</dependency>
+Gradle
implementation group: 'io.github.doocs', name: 'im-server-sdk-java', version: '0.4.10'
+下载 JAR
初始化
在使用腾讯云即时 IM 服务端 REST API 之前， 需要先通过 appId, userId, key 获取到一个 ImClient 实例:
// sdk appId
+long appId = 1400554812;
+
+// admin userId
+String userId = "test";
+
+// application key
+String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";
+
+// create a default ImClient instance
+ImClient client = ImClient.getInstance(appId, userId, key);
+
+// create a default ImClient instance with custom domain
+ImClient client = ImClient.getInstance(appId, userId, key, Domain.SINGAPORE);
+
+// create a custom ImClient instance
+ClientConfiguration config = new ClientConfiguration();
+config.setExpireTime(7 * 24 * 60 * 60L);
+config.setAutoRenewSig(false);
+ImClient client = ImClient.getInstance(appId, userId, key, config);
+ClientConfiguration 支持对以下参数进行自定义配置：
| 字段 | 类型 | 说明 | 默认值 |
|---|---|---|---|
maxRetries | int | HTTP 最大重试次数 | 3 |
connectTimeout | long | HTTP 连接超时（毫秒） | 10_000 |
readTimeout | long | HTTP 读超时（毫秒） | 10_000 |
writeTimeout | long | HTTP 写超时（毫秒） | 10_000 |
callTimeout | long | 一个完整的 HTTP 调用的时间限制。这包括解析 DNS、连接、写入请求正文、服务器处理以及读取响应正文。（毫秒） | 30_000 |
expireTime | long | UserSig 签名有效时长（秒） | 86400 |
autoRenewSig | boolean | 是否自动进行 UserSig 签名续期 | true |
userAgent | string | User-Agent | |
connectionPool | object | HTTP 连接池 |
使用示例
获取到 ImClient 实例后，就可以方便地进行 REST API 调用了。
我们以 账号管理-导入单个账号 为例：
AccountImportRequest request = AccountImportRequest.builder()
+ .identifier("admin")
+ .faceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4")
+ .nick("doocs")
+ .build();
+
+AccountImportResult result = client.account.accountImport(request);
+最近联系人
拉取会话列表
支持分页拉取会话列表。
使用示例：
GetRecentContactListRequest request = GetRecentContactListRequest.builder()
+ .fromAccount("doocs")
+ .timestamp(0)
+ .startIndex(0)
+ .topTimestamp(0)
+ .topStartIndex(0)
+ .assistFlags(AssistFlags.BIT_0)
+ .build();
+
+GetRecentContactListResult result = client.recentContact.recentContactList(request);
+删除单个会话
删除指定会话，支持同步清理漫游消息。
使用示例：
DeleteRecentContactRequest request = DeleteRecentContactRequest.builder()
+ .fromAccount("doocs_1")
+ .type(RecentContactType.C2C)
+ .toAccount("doocs_2")
+ .clearRamble(ClearRamble.YES)
+ .build();
+
+DeleteRecentContactResult result = client.recentContact.deleteRecentContact(request);
+创建会话分组数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记最多支持 1000 个会话，而一个用户最多支持 20 个会话分组。本接口支持会话分组数据的创建，仅旗舰版支持会话分组数据操作。
使用示例：
List<GroupContactItem> items = new ArrayList<>();
+GroupContactItem item = new GroupContactItem();
+item.setGroupName("groupName");
+
+List<ContactItem> contactItems = new ArrayList<>();
+ContactItem contactItem = new ContactItem();
+contactItem.setToAccount("ccc");
+contactItem.setToGroupId("group1");
+contactItem.setType(1);
+contactItems.add(contactItem);
+item.setContactItem(contactItems);
+items.add(item);
+CreateContactGroupRequest request = CreateContactGroupRequest.builder()
+ .fromAccount("test1")
+ .groupContactItem(items).build();
+
+CreateContactGroupResult result = client.recentContact.createContactGroup(request);
+更新会话分组数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记数据最多支持 1000 个会话。本接口支持会话分组数据的更新，仅旗舰版支持会话分组数据操作。
使用示例：
UpdateGroup updateGroup = UpdateGroup.builder().updateGroupType(1)
+ .newGroupName("hh").oldGroupName("cc").build();
+UpdateContactGroupRequest request = UpdateContactGroupRequest.builder()
+ .updateType(1)
+ .fromAccount("test1")
+ .updateGroup(updateGroup)
+ .build();
+
+UpdateContactGroupResult result = client.recentContact.updateContactGroup(request);
+删除会话分组数据
本接口支持删除用户的会话分组数据，仅旗舰版支持会话分组数据操作。
使用示例：
List<String> groupName = new ArrayList<>();
+groupName.add("hh");
+DelContactGroupRequest request = DelContactGroupRequest.builder()
+ .groupName(groupName)
+ .fromAccount("test1")
+ .build();
+
+DelContactGroupResult result = client.recentContact.delContactGroup(request);
+创建或更新会话标记数据
会话分组标记数据独立于最近联系人，RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记最多支持 1000 个会话。本接口支持会话标准标记以及会话自定义标记的创建或更新，仅旗舰版支持会话标准标记数据操作，自定义会话标记数据无限制。
使用示例：
List<MarkContactItem> items = new ArrayList<>();
+MarkContactItem item = new MarkContactItem();
+item.setClearMark(Collections.singletonList(1));
+item.setSetMark(Collections.singletonList(2));
+item.setOptType(1);
+items.add(item);
+MarkContactRequest request = MarkContactRequest.builder()
+ .fromAccount("test1")
+ .markItem(items)
+ .build();
+
+MarkContactResult result = client.recentContact.markContact(request);
+搜索会话分组标记
本接口根据指定的会话来查询对应会话分组标记数据。
使用示例：
SearchContactGroupRequest request = new SearchContactGroupRequest();
+request.setFromAccount("test1");
+ContactItem contactItem = new ContactItem();
+contactItem.setType(1);
+contactItem.setToAccount("test2");
+contactItem.setToGroupId("123");
+request.setContactItem(Collections.singletonList(contactItem));
+
+SearchContactGroupResult result = client.recentContact.searchContactGroup(request);
+拉取会话分组标记数据
本接口支持批量获取用户的会话分组标记数据。
使用示例：
GetContactGroupRequest request = new GetContactGroupRequest();
+request.setFromAccount("test1");
+request.setStartIndex(1);
+
+GetContactGroupResult result = client.recentContact.getContactGroup(request);
+机器人
创建机器人
本接口用于创建一个机器人账号，机器人是一种特殊账号，userid 必须以 @RBT# 开头，创建机器人时可以指定设置昵称、头像和签名。
说明
- 同一个机器人账号 userid 重复创建仅会创建 1 个机器人。
- 每个 IM 账号只能创建最多 20 个机器人账号。
使用示例：
CreateRobotRequest request = new CreateRobotRequest();
+request.setNick("bingo");
+request.setFaceUrl("https://avatars.githubusercontent.com/u/2784452?v=4");
+request.setSelfSignature("hah");
+request.setUserId("@RBT#1233232");
+
+CreateRobotResult result = client.robot.createRobot(request);
+删除机器人
本接口用于将一个机器人账号设置为无效，机器人是一种特殊账号，userid 必须以 @RBT# 开头。
说明
- 本接口将一个机器人账号设置为无效。
- 机器人账号 UserID 本身不会被删除。
使用示例：
DeleteRobotRequest request = DeleteRobotRequest.builder().robotAccount("@RBT#1233232").build();
+
+DeleteRobotResult result = client.robot.deleteRobot(request);
+拉取所有机器人
本接口用于拉取所有的机器人账号列表，机器人是一种特殊账号，userid 必须以 @RBT# 开头。
使用示例：
GetAllRobotsRequest request = new GetAllRobotsRequest();
+
+GetAllRobotsResult result = client.robot.getAllRobots(request);
+关系链管理
添加好友
添加好友，支持批量添加好友。
使用示例：
AddFriendItem addFriendItem = AddFriendItem.builder()
+ .toAccount("test2")
+ .addSource("AddSource_Type_XXXXXXXX")
+ .remark("Mr.A")
+ .groupName("schoolmate")
+ .addWording("Hi")
+ .build();
+List<AddFriendItem> addFriendItemList = Collections.singletonList(addFriendItem);
+FriendAddRequest request = FriendAddRequest.builder()
+ .fromAccount("test1")
+ .addFriendItemList(addFriendItemList)
+ .addType(AddType.BOTH)
+ .forceAddFlags(ForceAddFlags.FORCE)
+ .build();
+
+FriendAddResult result = client.sns.friendAdd(request);
+导入好友
- 支持批量导入单向好友。
- 往同一个用户导入好友时建议采用批量导入的方式，避免并发写导致的写冲突。
使用示例：
ImportFriendItem importFriendItem = ImportFriendItem.builder()
+ .toAccount("test2")
+ .addSource("AddSource_Type_XXXXXXXX")
+ .build();
+List<ImportFriendItem> importFriendItems = Collections.singletonList(importFriendItem);
+FriendImportRequest request = FriendImportRequest.builder()
+ .fromAccount("test1")
+ .importFriendItemList(importFriendItems)
+ .build();
+
+FriendImportResult result = client.sns.friendImport(request);
+更新好友
- 支持批量更新同一用户的多个好友的关系链数据。
- 更新一个用户多个好友时，建议采用批量方式，避免并发写导致的写冲突。
使用示例：
SnsItem snsItem = SnsItem.builder()
+ .tag("Tag_SNS_Custom_testTag")
+ .value(TagSns.IM_ADD_WORDING)
+ .build();
+List<SnsItem> snsItems = Collections.singletonList(snsItem);
+UpdateItem updateItem = UpdateItem.builder()
+ .toAccount("test2")
+ .snsItemList(snsItems)
+ .build();
+List<UpdateItem> updateItems = Collections.singletonList(updateItem);
+FriendUpdateRequest request = FriendUpdateRequest.builder()
+ .fromAccount("test1")
+ .updateItemList(updateItems)
+ .build();
+
+FriendUpdateResult result = client.sns.friendUpdate(request);
+删除好友
删除好友，支持单向删除好友和双向删除好友。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+FriendDeleteRequest request = FriendDeleteRequest.builder()
+ .deleteType(DeleteType.BOTH)
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+FriendDeleteResult result = client.sns.friendDelete(request);
+删除所有好友
清除指定用户的标配好友数据和自定义好友数据。
使用示例：
FriendDeleteAllRequest request = FriendDeleteAllRequest.builder()
+ .deleteType(DeleteType.BOTH)
+ .fromAccount("test1")
+ .build();
+
+FriendDeleteAllResult result = client.sns.friendDeleteAll(request);
+校验好友
支持批量校验好友关系。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+FriendCheckRequest request = FriendCheckRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .checkType(CheckResultType.BOTH)
+ .build();
+
+FriendCheckResult result = client.sns.friendCheck(request);
+拉取好友
- 分页拉取全量好友数据。
- 不支持资料数据的拉取。
- 不需要指定请求拉取的字段，默认返回全量的标配好友数据和自定义好友数据。
使用示例：
FriendGetRequest request = FriendGetRequest.builder()
+ .fromAccount("test1")
+ .startIndex(0)
+ .standardSequence(0)
+ .customSequence(0)
+ .build();
+
+FriendGetResult result = client.sns.friendGet(request);
+拉取指定好友
- 支持拉取指定好友的好友数据和资料数据。
- 建议每次拉取的好友数不超过 100，避免因数据量太大导致回包失败。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+List<String> tagList = Arrays.asList(TagProfile.IM_ADMIN_FORBID_TYPE, TagProfile.IM_ALLOW_TYPE);
+FriendGetListRequest request = FriendGetListRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .tagList(tagList)
+ .build();
+
+FriendGetListResult result = client.sns.friendGetList(request);
+添加黑名单
添加黑名单，支持批量添加黑名单。
注意
- 如果用户 A 与用户 B 之间存在好友关系，拉黑时会解除双向好友关系。
- 如果用户 A 与用户 B 之间存在黑名单关系，二者之间无法发起加好友请求。
- 如果用户 A 的黑名单中有用户 B 且用户 B 的黑名单中有用户 A，二者之间无法发起会话。
- 如果用户 A 的黑名单中有用户 B 但用户 B 的黑名单中没有用户 A，那么用户 A 可以给用户 B 发消息，用户 B 不能给用户 A 发消息。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListAddRequest request = BlackListAddRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+BlackListAddResult result = client.sns.blackListAdd(request);
+删除黑名单
删除指定黑名单。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListDeleteRequest request = BlackListDeleteRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .build();
+
+BlackListDeleteResult result = client.sns.blackListDelete(request);
+拉取黑名单
支持分页拉取所有黑名单。
使用示例：
BlackListGetRequest request = BlackListGetRequest.builder()
+ .fromAccount("test1")
+ .startIndex(0)
+ .maxLimited(10)
+ .lastSequence(0)
+ .build();
+
+BlackListGetResult result = client.sns.blackListGet(request);
+校验黑名单
支持批量校验黑名单。
使用示例：
List<String> toAccount = Collections.singletonList("test2");
+BlackListCheckRequest request = BlackListCheckRequest.builder()
+ .fromAccount("test1")
+ .toAccount(toAccount)
+ .checkType(BlackCheckResultType.BOTH)
+ .build();
+
+BlackListCheckResult result = client.sns.blackListCheck(request);
+添加分组
添加分组，支持批量添加分组，并将指定好友加入到新增分组中。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+List<String> toAccount = Collections.singletonList("test2");
+GroupAddRequest request = GroupAddRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .toAccount(toAccount)
+ .build();
+
+GroupAddResult result = client.sns.groupAdd(request);
+删除分组
删除指定分组。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+GroupDeleteRequest request = GroupDeleteRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .build();
+
+GroupDeleteResult result = client.sns.groupDelete(request);
+拉取分组
拉取分组，支持指定分组以及拉取分组下的好友列表。
使用示例：
List<String> groupName = Collections.singletonList("classmate");
+GroupGetRequest request = GroupGetRequest.builder()
+ .fromAccount("test1")
+ .groupName(groupName)
+ .needFriend(NeedFriendType.YES)
+ .build();
+
+GroupGetResult result = client.sns.groupGet(request);
+