IM 即时通讯
Windows/macOS
开发指南

圈组服务器管理

更新时间: 2023/06/29 14:47:16

前提条件

登录圈组

使用限制

单个用户的服务器的数量上限(包括自己创建的和加入的)默认为 100 个。

若需要扩展上限,可在控制台配置圈组子功能项(单个用户 server 数),具体请参考开通和配置圈组功能

创建服务器

功能介绍

您可通过 CreateServer 方法创建服务器。

参数说明

参数 类型 说明
anti_spam_info {} QChatBusinessAntiSpamInfo 配置反垃圾信息,可配置反垃圾文本业务 ID 或 反垃圾图片业务 ID。

示例代码

QChatServerCreateParam param;
param.server_info.name = "server name";
param.server_info.icon = "server icon url";
param.server_info.custom = "server custom";
param.server_info.invite_mode = kNIMQChatServerInviteModeNeedConfirm;
param.server_info.apply_mode = kNIMQChatServerApplyModeNormal;
param.anti_spam_info.text_bid = "anti spam text business id";
param.anti_spam_info.pic_bid = "anti spam pic business id";
param.cb = [this](const QChatServerCreateResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::CreateServer(param);

查询服务器

按照服务器ID查询

功能介绍

您可通过 GetServers 方法根据服务器 ID 查询服务器列表。

示例代码

QChatServerGetServersParam param;
param.server_ids = {"server id1", "server id2"};
param.cb = [this](const QChatServerGetServersResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::GetServers(param);

按照时间分页查询

功能介绍

您可通过 GetServersByPage 方法按时间分页查询服务器列表。

示例代码

QChatServerGetServersPageParam param;
param.timestamp = 0;
param.limit = 20;
param.cb = [this](const QChatServerGetServersPageResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::GetServersByPage(param);

更新服务器

功能介绍

您可通过 UpdateServer 方法更新服务器信息。

参数说明

参数说明

参数 类型 说明
anti_spam_info {} QChatBusinessAntiSpamInfo 配置反垃圾信息,可配置反垃圾文本业务 ID 或 反垃圾图片业务 ID。

示例代码

QChatServerUpdateParam param;
param.server_info.server_id = 123456;
param.server_info.name = "server name";
param.server_info.icon = "server icon url";
param.server_info.custom = "server custom";
param.server_info.invite_mode = kNIMQChatServerInviteModeNeedConfirm;
param.server_info.apply_mode = kNIMQChatServerApplyModeNormal;
param.anti_spam_info.text_bid = "anti spam text business id";
param.anti_spam_info.pic_bid = "anti spam pic business id";
param.cb = [this](const QChatServerUpdateResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::UpdateServer(param);

删除服务器

功能介绍

您可通过 DeleteServer 方法删除服务器。

示例代码

QChatServerDeleteParam param;
param.server_id = 123456;
param.cb = [this](const QChatServerDeleteResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::DeleteServer(param);

订阅服务器

功能介绍

您可通过 Subscribe 方法订阅指定服务器下的系统通知。

示例代码

QChatServerSubscribeParam param;
param.ope_type = kNIMQChatSubscribeOpeTypeSubscribe;
param.sub_type = kNIMQChatSubscribeTypeServerNotification;
param.server_ids = {123, 456};
param.cb = [this](const QChatServerSubscribeResp& resp) {
    if (resp.res_code != NIMResCode::kNIMResSuccess) {
        // error handling
        return;
    }
    // process response
    // ...
};
Server::Subscribe(param);
此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 使用限制
  • 创建服务器
  • 功能介绍
  • 参数说明
  • 示例代码
  • 查询服务器
  • 按照服务器ID查询
  • 功能介绍
  • 示例代码
  • 按照时间分页查询
  • 功能介绍
  • 示例代码
  • 更新服务器
  • 功能介绍
  • 参数说明
  • 参数说明
  • 示例代码
  • 删除服务器
  • 功能介绍
  • 示例代码
  • 订阅服务器
  • 功能介绍
  • 示例代码