产品动态
公告
Discord 实现指南
Discord 介绍
Discord 是一款专为社群设计的免费网络实时通话软件与数字发行平台，主要针对游戏玩家、教育人士、朋友及商业人士，用户之间可以在软体的聊天频道通过讯息、图片、影片和音讯进行交流。
Discord 概念
服务器
在 Discord 中有一种别于一般通讯软体之群组的群体聊天，称作伺服器（类似社团），伺服器拥有者可以在伺服器中创造属于自己的社群。
频道
在服务器中可以建立名为频道的聊天管道，分为语音、文字，其中的语音频道可以用来直播游戏与聊天等，频道可以设定与身份组整合各种权限，让 Discord 社群系统更加多样化。
子区
用户可以对特定的话题在子区内进行讨论。
准备工作
创建腾讯云 Chat 应用
了解相关配置和能力
使用腾讯云 Chat 实现 Discord 相关的功能，您需要提前了解腾讯云 Chat 相关的基础概念以及本教程后续会提到的一些专有名词，包括但不限于如下内容：
SDKAppID：腾讯云 Chat 会给每个应用分配一个 SDKAppID，在控制台创建应用后再应用详情页查看，开发者可以在初始化腾讯云Chat客户端 SDK 和计算用户登录票据时使用。详情可参考无 UISDK 初始化 以及 登录 文档。
密钥：在腾讯云 Chat 控制台应用详情页可查看当前应用密钥，在计算用户登录 SDK 票据时会用到。
用户账号：登录腾讯云 Chat 用户必须在腾讯云 Chat 的账号体系中，当用户使用客户端 SDK 登录成功时，腾讯云 Chat 后台会自动创建 Chat 用户。同时，可以使用腾讯云 Chat 提供的服务端 API 将用户导入到 Chat 的用户体系中。
群组：到目前为止，Chat根据不同场景的需要，提供了 5种类型的群，用户在群里发言，群成员均可收到消息。
回调配置：开发者除了可以主动集成 Chat 提供的客户端 SDK 与服务端 API，Chat 也会主动在特定的业务逻辑出发时将必要的信息回到给开发者服务端。只需要开发者在腾讯云 Chat 控制台 回调配置 模块完成相应的配置即可。腾讯云 Chat 提供了丰富的回调配置，并且保证回调的高可靠，开发者可通过回调实现很多自定义需求。
自定义字段：默认情况下，腾讯云 Chat 提供给开发者使用的字段能满足绝大部分需求，如用户需要扩展字段，腾讯云 Chat 也为各个模块提供了自定一字段，如：
说明：
用户使用自定义字段，可现在控制台进行配置，再使用 SDK\\API 进行读写即可。
集成客户端&服务端 SDK
在实现 Discord 相关的功能时，需要集成 ChatSDK，腾讯云 Chat 提供了丰富且易用的 SDK 以及服务端 API，使用同一 SDKAppID 登录的应用，在各个端上消息互通。开发者可根据自己的业务需求场景以及技术栈进行评估，选择合适的 SDK。
Discord 功能分析
Discord 的功能主要分为服务器、频道、以及子区，服务器与服务器之间是内容上的区别，如王者荣耀服务器，和平精英服务器等，在服务器内可以创建不同类型的频道，如文字频道，语音频道、公示频道等。用户的交流实际是在各个频道中进行的。当用户对交流的某一个内容有更多的想法时，可以选择对该内容创建子区来进行更多的交流。Discord 的核心玩法就如分析的这样，接下来本教程会逐一分析如何通过腾讯云 Chat 来实现相关的功能。
说明：
服务器
创建服务器
经过分析可以知道，Discord 的服务器列表有这样一些特性：
1. 服务器中人数可能特别多。
2. 用户实际不会在服务器中交流，只会在服务器内的频道或者子区中聊天。
3. 服务器中的聊天历史需要存漫游。
4. 可自由进入。
5. 可以在服务器中创建频道。
虽然 Chat 提供了五种不同类型的群，但从 Discord 的服务器特性来看，只有 社群（Community） 符合服务器的特性，腾讯云 Chat 社群创建后可以随意进出，最多支持10w人，支持历史消息存储，用户搜索群 ID 发起加群申请后，无需管理员审批即可进群。
可通过腾讯云 Chat 提供的 createGroup 接口进行服务器（群）创建，需要注意的是，创建的群类型为Community、setSupportTopic 需要设置为 true，这样才可在服务器中创建频道。演示代码如下：
V2TIMGroupInfo groupinfo = new V2TIMGroupInfo();groupinfo.setGroupName("测试服务器");groupinfo.setSupportTopic(true);// 初始群成员List<V2TIMCreateGroupMemberInfo> memberList = new LinkedList<V2TIMCreateGroupMemberInfo>();// 其他配置，如服务器头像等V2TIMManager.getGroupManager().createGroup(groupinfo, memberList, new V2TIMValueCallback<String>() {@Overridepublic void onError(int i, String s) {// 创建失败}@Overridepublic void onSuccess(String s) {// 创建成功，返回服务器ID}});
接口调用成功后，会在 onSuccess 回调中返回服务器 ID，在后续的在服务器中创建频道的功能中会用到。
注意：
{"Type": "Community", // 群组类型 (必填)"Name": "TestCommunityGroup", // 群组名称 (必填)"SupportTopic": 1 // 是否支持话题选项, 1代表支持,0代表不支持}
###### 服务器列表在 Discord 最左侧有个服务器列表的功能，展示的是用户已加入的服务器列表。针对与社群场景，腾讯云 IM 提供了专门的 API 进行查询```javaV2TIMManager.getGroupManager().getJoinedCommunityList(new V2TIMValueCallback<List<V2TIMGroupInfo>>() {@Overridepublic void onSuccess(List<V2TIMGroupInfo> v2TIMGroupInfos) {// 获取服务器列表成功，返回的List<V2TIMGroupInfo>代表服务器列表的基本信息}@Overridepublic void onError(int i, String s) {// 获取服务器列表失败}});
在返回的 V2TIMGroupInfo 列表，代表的是服务器的基本信息。但是在基本信息中，并没有服务器的未读数以及自定义状态等相关信息。因此想要实现 Discord 一样的效果需要借助 Chat 提供的其他 API 来实现，服务器列表的未读数，在后面的小节中讲到。
服务器分类
创建服务器时，会个服务器创建默认的分类，创建后也可在创建新的分类，服务器在腾讯云 Chat 中本质上是一个社群，因此可以通过设置社群的自定义字段来进行实现。使用群自定义字段可分为两步：
1. 在控制台开启自定义字段 key。
2. 使用客户端 SDK\\服务端 API 进行读写。
注意：
社群为专业版、专业版Plus或企业版能力，设置社群的自定义字段需要先购买专业版、专业版Plus或企业版。
服务器消息未读数&自定义状态展示
上一小节提到在获取已加入的服务器列表 API 中，没有返回未读数以及服务器状态等信息。需要注意的是，我们不仅仅要获取到这个数据，还需要监听这个数据的变化从而及时的更新客户端 UI，由于服务器使用Chat社群实现，且社群在 Chat 中不会产生会话，因此需要统计所有公有的频道的会话以及私有的频道会话之和。通过 V2TIMTopicInfo 的 getUnreadCount 获取公有频道的未读数，由于私有频道由 work 群实现所以可通过 getConversation 来获取私有频道的未读数。
// 公有频道List<String> conversationIDList = new LinkedList();conversationIDList.add("GROUP_$GROUPID");V2TIMManager.getConversationManager().getConversationList(conversationIDList, new V2TIMValueCallback<List<V2TIMConversation>>() {@Overridepublic void onError(int i, String s) {// 获取服务器对应的会话信息失败}@Overridepublic void onSuccess(V2TIMConversationList List<V2TIMConversation>) {// 获取服务器对应的会话信息成功}});// 私有频道V2TIMManager.getGroupManager().getTopicInfoList(groupID, topicIDList, new V2TIMValueCallback<List<V2TIMTopicInfoResult>>() {@Overridepublic void onSuccess(List<V2TIMTopicInfoResult> v2TIMTopicInfoResults) {}@Overridepublic void onError(int i, String s) {}});
List<String> conversationIDList = new LinkedList();String customData = "通话中"V2TIMManager.getConversationManager().setConversationCustomData(conversationIDList, customData, new V2TIMValueCallback<List<V2TIMConversationOperationResult>>() {@Overridepublic void onSuccess(List<V2TIMConversationOperationResult> v2TIMConversationOperationResults) {// 设置群会话自定义数据成功}@Overridepublic void onError(int i, String s) {// 设置群会话自定义数据失败}});
当服务器会话的相关数据发生改变时，客户端需要试试更新 UI 的展示，对于监听服务器会话的改变，Chat 提供了对应的事件监听函数 addConversationListener，当以下信息修改时，会触发该回调函数。
1. 服务器消息增删改
2. 服务器消息未读数改变
3. 服务器自定义信息改变
4. 服务器置顶
5. 服务器接受消息配置改变
6. 服务器标记改变
7. 服务器分组改变
8. ...
V2TIMConversationListener conversationLister = new V2TIMConversationListener() {@Overridepublic void onSyncServerStart() {}@Overridepublic void onSyncServerFinish() {}@Overridepublic void onSyncServerFailed() {}@Overridepublic void onNewConversation(List<V2TIMConversation> conversationList) {}@Overridepublic void onConversationChanged(List<V2TIMConversation> conversationList) {}@Overridepublic void onTotalUnreadMessageCountChanged(long totalUnreadCount) {}@Overridepublic void onConversationGroupCreated(String groupName, List<V2TIMConversation> conversationList) {}@Overridepublic void onConversationGroupDeleted(String groupName) {}@Overridepublic void onConversationGroupNameChanged(String oldName, String newName) {}@Overridepublic void onConversationsAddedToGroup(String groupName, List<V2TIMConversation> conversationList) {、}@Overridepublic void onConversationsDeletedFromGroup(String groupName, List<V2TIMConversation> conversationList) {}}V2TIMManager.getConversationManager().addConversationListener(conversationLister);
综上通过 getJoinedCommunityList、getConversationList 接口以及 addConversationListener 回调，可以实现 Discord 的展示服务器列表的功能。
频道
在服务器内，可创建多个频道。在该服务器下创建了四个频道，并且将四个频道放到了两个分类中。
对于频道，用户可以邀请用户加入以及对频道进行基本的设置。用户大多数的聊天是在频道内进行的，因此频道的能力在 Discord 中是最重要的。对应于腾讯云 Chat，即是话题的能力。在 Chat 社群支持在在社群内创建话题的能力。
默认频道
Discord 会在创建服务器时，默认创建四个频道，使用腾讯云 Chat 也可以实现这样的功能，具体流程如下：
1. 使用 创建群后回调 通知业务服务端创服务器成功。
2. 业务侧判断是是否创建的社群，以免影响其他群相关的业务。
3. 根据服务器属性，在服务端创建话题。
服务端创建话题主要参数如下：
{"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所属的群ID（必填）"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic", // 用户自定义话题 ID（选填）"TopicName": "TestTopic", // 话题的名称（必填）"From_Account": "1400187352", // 创建话题的成员"CustomString": "This is a custom string", // 自定义字符串"FaceUrl": "http://this.is.face.url", // 话题头像 URL（选填）"Notification": "This is topic Notification", // 话题公告（选填）"Introduction": "This is topic Introduction" // 话题简介（选填）}
创建频道
在 Discord 客户端，用户可以在频道分类下创建频道。
如上所分析，创建频道在 Chat 中即为在社群中创建话题。并且在创建时，可以对话题进行分类，设置话题基本信息。
String groupID = "服务器ID"V2TIMTopicInfo info = new V2TIMTopicInfo();info.setCustomString("{'categray':'游戏','type':'text'}") // 设置频道分类以及类型// 这里可以设置V2TIMTopicInfo的具体信息V2TIMManager.getGroupManager().createTopicInCommunity(groupID, info, new V2TIMValueCallback<String>() {@Overridepublic void onSuccess(String s) {// 创建频道成功}@Overridepublic void onError(int i, String s) {// 创建频道失败}});
在创建频道时，可设置频道是否是私密频道，私密频道和普通频道不同。
1. 用户加入服务器后，不会加入私密频道。
2. 私密频道需要服务器管理员邀请进入。
因此，我们可以使用一个 work 群来实现私密频道的功能，但是一个服务器绑定了哪些私密频道的信息需要业务侧来存储。
频道类型
Discord 在创建频道时，可选择频道类型为语音频道或者文字频道，文字频道即为普通的文字、表情、图片聊天，语音频道则为音视频聊天。需要注意的是，同一用户同一时间内只能在一个语音频道内。用户加入新的语音频道需要退出当前已加入的语音频道。
因此这里有4个注意点：
1. 创建频道时需设置频道类型，在创建频道小节中有讲到如何设置频道类型。
2. 用户加入语音频道时需判断是否已经在其他语音频道。
3. 语音频道是全局的。
4. 腾讯云 Chat 暂时未提供用户是否在语音频道以及在哪个语音频道的 API，因此此部分的数据需要业务侧来维护。
针对第4点，开发者可以使用腾讯云 Chat 提供的进群后回调以及退群回调，维护用户是否在语音频道的状态，并且将该状态存在业务侧存储内。需要注意的是，腾讯云 Chat 的回调可能存在延迟，即用户退出语音频道后，短时间内仍可能不能加入其他语音频道。因此也可以用过客户端上报的方式来处理，即将用户的进退语音频道的状态实时上报给业务服务端。
邀请用户进入频道
用户进入频道有三种方式：
1. 邀请用户进入服务器，进入服务器的用户会进入所有的公开的频道。
2. 用户通过搜索进入服务器。
3. 私有频道通过服务器管理员邀请进入。
通过社群的特性可知，用户进入共有频道，只需加入服务器即可。
1. 支持精准搜索群 ID 加入。
2. 支持邀请人进入。
3. 支持主动申请进入，且无需审批。
频道设置
// 设置频道基本信息V2TIMManager.getGroupManager().setTopicInfo(topicInfo, new V2TIMCallback() {@Overridepublic void onSuccess() {// 设置成功}@Overridepublic void onError(int i, String s) {// 设置失败}});
// 设置频道如何接受消息String groupID = "topicid"int opt = 0;V2TIMManager.getMessageManager().setGroupReceiveMessageOpt(groupID, opt, new V2TIMCallback() {@Overridepublic void onSuccess() {}@Overridepublic void onError(int i, String s) {}});
频道消息列表
final V2TIMMessageListGetOption option = new V2TIMMessageListGetOption();option.setGroupID("频道ID");option.setCount(20);// 其他配置V2TIMManager.getMessageManager().getHistoryMessageList(option, new V2TIMValueCallback<List<V2TIMMessage>>() {@Overridepublic void onSuccess(List<V2TIMMessage> v2TIMMessages) {// 获取频道历史消息成功}@Overridepublic void onError(int code, String desc) {// 获取频道历史消息失败}});
频道消息未读数
String groupID = "服务器ID";List< String > topicIDList= new LinkedList(); // 频道消息列表V2TIMManager.getGroupManager().getTopicInfoList(groupID, topicIDList, new V2TIMValueCallback<List<V2TIMTopicInfoResult>>() {@Overridepublic void onSuccess(List<V2TIMTopicInfoResult> v2TIMTopicInfoResults) {// 获取频道信息，如频道id、频道名字、未读数等}@Overridepublic void onError(int i, String s) {}});
频道成员名单
加入服务器的用户默认会加入到所有的公有频道中，因此查看服务器的群成员列表即可。功能频道获取成员列表：
String groupID = "服务器ID";int filter = 0; // 群成员角色 管理员 普通成员 ...long nextSeq = 0;// 分页参数V2TIMManager.getGroupManager().getGroupMemberList(groupID, filter, nextSeq , new V2TIMValueCallback<V2TIMGroupMemberInfoResult>() {@Overridepublic void onError(int i, String s) {CommonUtil.returnError(result,i,s);}@Overridepublic void onSuccess(V2TIMGroupMemberInfoResult v2TIMGroupMemberInfoResult) {}});
身份证权限
权限组可以根据用户实际使用需求自定义群组的使用权限，通过在不同的权限组配置不同的权限以及成员，来实现分组分权限管理群组。社群可使用权限组来管理，相比于职责固定的 管理员 的管理，权限组的管理则更加灵活，能够适用于社群成员较多、话题较多的场景。
权限组客户端集成使用示例可参见：无 UI 集成 > 社群话题 > 权限组
权限组服务端集成使用示例可参见：服务端 API > REST API > 权限组管理 > 创建权限组
子区
子区是对于频道内消息进行进一步讨论的群组，用户可以集中浏览一个频道内用户讨论的重点，在频道内消息列表中，也可以看到子区的概要。子区在腾讯云Chat里也是群的概念，一个子区即为一个群。
创建子区
子区的创建可以邦迪频道内的一条消息，也可以单独创建，可以通过腾讯云 Chat 提供的创建群 createGroup 接口创建子区,但需要注意以下几点：
1. 新创建的子区，服务器内的所有成员，默认都在子区内。
2. 子区创建后加入服务器的成员也都会加入到子区。
3. 后加入子区的用户能看到子区创建后的历史聊天记录。
综上，创建一个子区，需要创建群时，将服务器中群成员加入子区，用户加入服务器时，需要在用户进群后回调中，将用户加入到服务器所有子区中。这两个步骤最好是在业务服务端进行，需要用到的 API 如下：
1. 查询 服务器中成员。
2. 创建群并设置群成员。
3. 邀请用户进群。
子区数量
在频道列表中，可以获取到频道下的子区列表，因此需要绑定子区与服务器的多对一的关系。如果子区对应有历史消息，也要绑定子区与消息的一对一关系，腾讯云 Chat 暂未提供绑定上述关系的能力，因此需要业务侧额外维护。通过业务提供的 HTTP 接口来获取子区的数量以及子区列表。通过发送在线消息，来实时刷新子区列表。
子区概要
当对一条消息进行创建子区时，会在消息列表中看到子区的消息概要：
1. 该子区有多少条消息。
2. 该子区中 lastMessage 的相关信息。
3. 信息需要实时显示在消息列表中。
要实现子区的消息概要能力，需要结合群内发消息后回调、以及消息编辑的能力。用户在子区发消息后，Chat 服务触发发消息后回调，将相关信息同步给业务侧，业务进行消息计数，并且维护 lastMessage 相关信息，同时将信息通过消息编辑 API 保存到消息上。
消息相关
消息反馈
消息反馈即为用户对消息进行扩展。
因为所有有的消息类型均可以进行编辑和反馈，并且需要支持社群，因此我们建议将数据保存在 cloudCustomData 字段上，详细的的数据存储格式可以参考：
{"reaction": {"simle":["user1","user2"]}}
V2TIMManager.getMessageManager().modifyMessage(modifiedMessage, new V2TIMCompleteCallback<V2TIMMessage>() {@Overridepublic void onComplete(int i, String s, V2TIMMessage v2TIMMessage) {// 消息修改完成}});
消息编辑
消息编辑与消息反馈原理一样，仅仅设置的自定义数据上有些区别，同样为了所有消息都能够适用消息编辑，建议编辑 cloudCustomData 字段，数据格式如下：
{"isEdited": true}
V2TIMManager.getMessageManager().modifyMessage(modifiedMessage, new V2TIMCompleteCallback<V2TIMMessage>() {@Overridepublic void onComplete(int i, String s, V2TIMMessage v2TIMMessage) {// 消息编辑完成}});
消息标注
消息标注即用户在群聊中将消息进行标注，其他用户可以看到被标注的消息。由于社群暂不支持群属性，因此这里使用自定义消息实现消息标注能力。
其次进行设置：
V2TIMGroupInfo info = new V2TIMGroupInfo();info.setCustomInfo("pin data");V2TIMManager.getGroupManager().setGroupInfo(info, new V2TIMCallback() {@Overridepublic void onError(int i, String s) {// 设置失败}@Overridepublic void onSuccess() {// 设置成功}});
List< String > groupIDList = new LinkedList();V2TIMManager.getGroupManager().getGroupsInfo(groupIDList, new V2TIMValueCallback<List<V2TIMGroupInfoResult>>() {@Overridepublic void onError(int i, String s) {}@Overridepublic void onSuccess(List<V2TIMGroupInfoResult> v2TIMGroupInfoResults) {}});
需要注意的是，目前自定义字段只能配置在服务器上，不能配置在频道上。
正在输入中状态
当好友正在输入时，其他用户端可以看见用户正在输入中的状态，如上如所示，可以使用腾讯云Chat提供的在线消息提供，此消息：
1. 仅在线用户才会收到。
2. 不会存入消息漫游。
同时，为了优化性能，我们也可以有一些优化如：
20s之内发送给消息的用户双方才会触发正在输入中状态消息的发送。
同一文本消息不触发多次在线消息发送。
私信
私信即 Discord 用户与用户之间可以发送消息，不管用户之间是否有好友关系。
如果用户没有好友关系，发送消息除了需要知道用户 ID 之外，还需要在腾讯云 Chat 控制台关闭 发送消息检测 关系链的选项，否则会发送消息失败。
用户也可以先通过 addFriend 接口添加好友，通过 getFriendList 来获取自己的好友列表。
相关代码如下：
// 添加好友V2TIMManager.getFriendshipManager().addFriend(info, new V2TIMValueCallback<V2TIMFriendOperationResult>() {@Overridepublic void onError(int i, String s) {// 添加好友失败}@Overridepublic void onSuccess(V2TIMFriendOperationResult v2TIMFriendOperationResult) {// 添加好友成功}});
// 获取好友列表V2TIMManager.getFriendshipManager().getFriendList(new V2TIMValueCallback<List<V2TIMFriendInfo>>() {@Overridepublic void onError(int i, String s) {// 获取好友列表失败}@Overridepublic void onSuccess(List<V2TIMFriendInfo> v2TIMFriendInfos) {// 获取好友列表成功}});
个人中心
在线状态
Discord 用户面板的在线状态能力，可以通过腾讯云 Chat 提供的在线状态 API 来实现：
通过 setSelfStatus 来设置自己的自定义在线状态，用户的自己的在线\\离线状态是 Chat 设置的，开发者不能更改。
通过 getUserStatus 来获取好友的在线状态。
通过 onUserStatusChanged 来监听好友的在线状态改变。
相关代码如下：
// 设置个人在线状态V2TIMUserStatus customStatus = new V2TIMUserStatus();V2TIMManager.getInstance().setSelfStatus(customStatus, new V2TIMCallback() {@Overridepublic void onSuccess() {}@Overridepublic void onError(int i, String s) {}});
// 获取好友在线状态List<String> userIDList = new LinkerList();V2TIMManager.getInstance().getUserStatus(userIDList, new V2TIMValueCallback<List<V2TIMUserStatus>>() {@Overridepublic void onSuccess(List<V2TIMUserStatus> v2TIMUserStatuses) {}@Overridepublic void onError(int i, String s) {}});
个人信息相关
个人信息相关的功能可通过腾讯云 Chat 提供的资料关系链相关的 API 实现：
获取个人资料 getUsersInfo。
设置个人资料 setSelfInfo。
// 设置个人资料final V2TIMUserFullInfo userFullInfo = new V2TIMUserFullInfo();V2TIMManager.getInstance().setSelfInfo(userFullInfo, new V2TIMCallback() {@Overridepublic void onError(int i, String s) {}@Overridepublic void onSuccess() {}});
// 获取用户资料List<String> userIDList = new LinkedList();V2TIMManager.getInstance().getUsersInfo(userIDList, new V2TIMValueCallback<List<V2TIMUserFullInfo>>() {@Overridepublic void onError(int i, String s) {}@Overridepublic void onSuccess(List<V2TIMUserFullInfo> v2TIMUserFullInfos) {}});
其他
搜索功能
Discord 的搜索能力如下：
腾讯云 Chat 提供了丰富的搜索能力，包括：
搜索消息 searchLocalMessages。
搜索群组 searchGroups。
搜索群成员 searchGroupMembers。
搜索好友 searchFriends。
离线推送功能
敏感词校验
在发送信息、配置资料时，需要对内容进行过滤，腾讯云Chat也提供了这样的方案，帮助用户更加合规的使用 Chat。
文档反馈