服务端
API 参考
圈组

圈组 API 概览

更新时间: 2024/03/15 14:27:33

您可调用获取圈组连接地址(https://api.netease.im/nimserver/qchat/requestAddr.action)获取应用客户端与圈组服务端的连接地址。用户登录圈组时,必须传入该连接地址。

本文主要罗列了圈组功能相关的 API 列表。

圈组模块的所有 API 都存在频控:

每个接口在单个应用中默认最高调用频率:100 次/秒,如超限,将被屏蔽 10 秒。若根据业务需要调整部分接口的频控,请通过官网首页右侧的联系方式联系云信商务经理。

圈组服务器相关

API 请求URL
创建圈组服务器 https://api.netease.im/nimserver/qchat/createServer.action
修改圈组服务器信息 https://api.netease.im/nimserver/qchat/updateServer.action
删除圈组服务器 https://api.netease.im/nimserver/qchat/removeServer.action
批量查询服务器信息 https://api.netease.im/nimserver/qchat/getServers.action
分页查询服务器列表 https://api.netease.im/nimserver/qchat/getServerListPage.action

圈组服务器成员相关

API 请求URL
邀请服务器成员 https://api.netease.im/nimserver/qchat/inviteServerMember.action
接受邀请 https://api.netease.im/nimserver/qchat/acceptServerInvite.action
拒绝邀请 https://api.netease.im/nimserver/qchat/rejectServerInvite.action
申请加入服务器 https://api.netease.im/nimserver/qchat/applyServer.action
接受申请 https://api.netease.im/nimserver/qchat/acceptServerApply.action
拒绝申请 https://api.netease.im/nimserver/qchat/rejectServerApply.action
生成邀请码 https://api.netease.im/nimserver/qchat/generateInviteCode.action
通过邀请码加入 https://api.netease.im/nimserver/qchat/joinServerByInviteCode.action
踢出成员 https://api.netease.im/nimserver/qchat/kickServerMember.action
主动退出服务器 https://api.netease.im/nimserver/qchat/leaveServer.action
修改自己的成员信息 https://api.netease.im/nimserver/qchat/updateServerMember.action
修改他人的成员信息 https://api.netease.im/nimserver/qchat/updateOtherServerMember.action
分页查询服务器成员列表 https://api.netease.im/nimserver/qchat/getServerMemberListPage.action
批量查询服务器成员信息 https://api.netease.im/nimserver/qchat/getServerMembers.action
查询服务器的申请和邀请记录 https://api.netease.im/nimserver/qchat/queryInviteApplyHistoryByServer.action
查询个人的申请和邀请记录 https://api.netease.im/nimserver/qchat/queryInviteApplyHistoryByUser.action
更新成员封禁状态 https://api.netease.im/nimserver/qchat/updateServerMemberBan.action
分页查询封禁成员列表 https://api.netease.im/nimserver/qchat/getServerMemberBanListPage.action

圈组频道相关

API 请求URL
创建频道 https://api.netease.im/nimserver/qchat/createChannel.action
修改频道基础信息 https://api.netease.im/nimserver/qchat/updateChannel.actionC
修改频道分组相关信息 https://api.netease.im/nimserver/qchat/updateCategoryInfoOfChannel.action
删除频道 https://api.netease.im/nimserver/qchat/removeChannel.action
分页查询频道列表 https://api.netease.im/nimserver/qchat/getChannelListPage.action
批量查询频道信息 https://api.netease.im/nimserver/qchat/getChannels.action
分页查询频道成员列表 https://api.netease.im/nimserver/qchat/getChannelMemberListPage.action
修改频道黑白名单成员 https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentifyUser.action
修改频道黑白名单身份组 https://api.netease.im/nimserver/qchat/updateWhiteBlackIdentify.action
分页查询频道黑白名单成员列表 https://api.netease.im/nimserver/qchat/queryWhiteBlackIdentifyUser.action
分页查询频道黑白名单身份组列表 https://api.netease.im/nimserver/qchat/queryWhiteBlackIdentify.action
批量查询频道黑白名单成员 https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentifyUser.action
批量查询频道黑白名单身份组 https://api.netease.im/nimserver/qchat/batchGetWhiteBlackIdentify.action

圈组频道分组相关

API 请求URL
创建频道分组 https://api.netease.im/nimserver/qchat/createChannelCategory.action
删除频道分组 https://api.netease.im/nimserver/qchat/removeChannelCategory.action
修改频道分组信息 https://api.netease.im/nimserver/qchat/updateChannelCategory.action
批量查询频道分组信息 https://api.netease.im/nimserver/qchat/getChannelCategorys.action
分页查询服务器下频道分组信息 https://api.netease.im/nimserver/qchat/getChannelCategoryListByServerPage.action
分页查询频道分组下的频道信息 https://api.netease.im/nimserver/qchat/getChannelListByChannelCategoryPage.action
修改频道分组黑白名单身份组 https://api.netease.im/nimserver/qchat/updateCategoryWhiteBlackIdentify.action
修改频道分组黑白名单成员 https://api.netease.im/nimserver/qchat/updateCategoryWhiteBlackIdentifyUser.action
分页查询频道分组黑白名单身份组 https://api.netease.im/nimserver/qchat/queryCategoryWhiteBlackIdentifyPage.action
查询频道分组黑白名单成员 https://api.netease.im/nimserver/qchat/queryCategoryWhiteBlackIdentifyUserPage.action
批量查询频道分组黑白名单身份组 https://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentify.action
批量查询频道分组黑白名单成员 https://api.netease.im/nimserver/qchat/batchGetCategoryWhiteBlackIdentifyUser.action

圈组身份组相关

API 请求URL
创建服务器身份组 https://api.netease.im/nimserver/qchat/createServerIdentify.action
修改服务器身份组 https://api.netease.im/nimserver/qchat/updateServerIdentify.action
删除服务器身份组 https://api.netease.im/nimserver/qchat/removeServerIdentify.action
批量更新服务器身份组优先级 https://api.netease.im/nimserver/qchat/batchUpdateServerIdentifyPriority.action
分页查询服务器身份组 https://api.netease.im/nimserver/qchat/getServerIdentifyPages.action
添加服务器身份组成员 https://api.netease.im/nimserver/qchat/createServerIdentifyMember.action
移除服务器身份组成员 https://api.netease.im/nimserver/qchat/deleteServerIdentifyMember.action
分页查询服务器身份组成员 https://api.netease.im/nimserver/qchat/getServerIdentifyMemberPages.action
分页查询用户所属的身份组 https://api.netease.im/nimserver/qchat/getUserServerIdentify.action
创建频道身份组 https://api.netease.im/nimserver/qchat/createChannelIdentify.action
修改频道身份组 https://api.netease.im/nimserver/qchat/updateChannelIdentify.action
删除频道身份组 https://api.netease.im/nimserver/qchat/deleteChannelIdentify.action
分页查询频道身份组 https://api.netease.im/nimserver/qchat/getChannelIdentifyPages.action
创建用户定制权限 https://api.netease.im/nimserver/qchat/createUserIdentify.action
删除用户定制权限 https://api.netease.im/nimserver/qchat/deleteUserIdentify.action
修改用户定制权限 https://api.netease.im/nimserver/qchat/updateUserIdentify.action
分页查询用户定制权限 https://api.netease.im/nimserver/qchat/getUserIdentifyPages.action
创建频道分组身份组 https://api.netease.im/nimserver/qchat/createChannelCategoryIdentify.action
修改频道分组身份组 https://api.netease.im/nimserver/qchat/updateChannelCategoryIdentify.action
删除频道分组身份组 https://api.netease.im/nimserver/qchat/deleteChannelCategoryIdentify.action
分页查询频道身份组列表 https://api.netease.im/nimserver/qchat/getChannelCategoryIdentify.action
创建频道分组下某人的定制权限 https://api.netease.im/nimserver/qchat/createChannelCategoryUserIdentify.action
删除频道分组下某人的定制权限 https://api.netease.im/nimserver/qchat/deleteChannelCategoryUserIdentify.action
修改频道分组下某人的定制权限 https://api.netease.im/nimserver/qchat/updateChannelCategoryUserIdentify.action
分页查询频道分组下某人的定制权限 https://api.netease.im/nimserver/qchat/getChannelCategoryUserIdentify.action
创建自定义权限 https://api.netease.im/nimserver/qchat/createCustomAuth.action
删除自定义权限 https://api.netease.im/nimserver/qchat/deleteCustomAuth.action
查询所有自定义权限 https://api.netease.im/nimserver/qchat/listAllCustomAuth.action
查询自定义权限项列表 https://api.netease.im/nimserver/qchat/listCustomAuthByAuthBits.action
查询用户拥有的权限 https://api.netease.im/nimserver/qchat/queryIdentifyResources.action

圈组消息相关

API 请求URL
圈组发送消息 https://api.netease.im/nimserver/qchat/sendMsg.action
更新消息 https://api.netease.im/nimserver/qchat/updateMsg.action
查询云端历史消息 https://api.netease.im/nimserver/qchat/queryHistoryMsg.action
查询 Thread 聊天历史 https://api.netease.im/nimserver/qchat/queryThreadTalkHistory.action
批量查询 Thread 聊天 meta 信息 https://api.netease.im/nimserver/qchat/batchQueryThreadTalkMeta.action
更新快捷评论 https://api.netease.im/nimserver/qchat/updateQuickComment.action
查询快捷评论 https://api.netease.im/nimserver/qchat/queryQuickComment.action
查询@某人的未读消息 https://api.netease.im/nimserver/qchat/queryChannelUnReadMentionedMsgPage.action

圈组系统通知相关

API 请求URL
发送自定义系统通知 https://api.netease.im/nimserver/qchat/sendAttachMsg.action
更新自定义系统通知 https://api.netease.im/nimserver/qchat/updateAttachMsg.action

圈组搜索结果自定义排序相关

API 请求URL
修改服务器自定义排序值 https://api.netease.im/nimserver/qchat/batchUpdateServerReorderWeight.action
修改频道自定义排序值 https://api.netease.im/nimserver/qchat/batchUpdateChannelReorderWeight.action
此文档是否对你有帮助?
有帮助
去反馈
  • 圈组服务器相关
  • 圈组服务器成员相关
  • 圈组频道相关
  • 圈组频道分组相关
  • 圈组身份组相关
  • 圈组消息相关
  • 圈组系统通知相关
  • 圈组搜索结果自定义排序相关