服务端
API 参考
圈组

创建服务器

更新时间: 2024/05/24 15:31:15

云信服务端支持创建圈组的服务器。

功能介绍

圈组服务器(Server)并非传统意义上的服务器,它是社群本身。所有的内容、兴趣、话题、关系都是以此为基础进行发展的。在圈组的场景下,任何行为的开始前都应该先创建一个圈组服务器。当用户开始邀请朋友时,是以圈组服务器的维度去发起邀请的。也就是说,用户的朋友加入的是圈组服务器。它是关系的集合。

如下图的 UI 示例所示,通过服务器,可将用户集合到一起进行统一管理,并可在服务器内创建承载各类话题的频道

使用限制

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

可在云信控制台配置单个用户的服务器数量上限。(在云信控制台选择应用,进入IM 即时通讯 > 功能配置 > 圈组 > 子功能配置 > 单个用户server数即可配置。)

URL

httpPOST https://api.netease.im/nimserver/qchat/createServer.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
accidString操作者的 IM 帐号
nameString圈组服务器名称,最大长度 64 位字符
iconString圈组服务器图标 URL ,最大长度 1024 位字符
customString自定义扩展,最大长度 1024 位字符
inviteModeString圈组服务器邀请模式
0,邀请需要被邀请人的同意(默认);1,邀请不需要同意。其它返回 414 错误码
applyModeString圈组服务器申请模式
0,申请加入不需要创建者或管理员的同意(默认);1,申请需要同意。其它返回 414 错误码
bidString安全通的自定义反垃圾(即内容审核)业务的 ID。自定义反垃圾业务主要用来针对单条消息或单次操作的资料信息进行除了默认反垃圾业务以外的内容审核。如需配置自定义反垃圾,请通过云信官网首页提供的微信、在线聊天和电话等方式联系商务经理进行配置,并获取对应的业务 ID,可转换为 JSON 格式,如:{"textbid":"","picbid":""}
searchTypeInteger用户自定义搜索类型:大于 0 的整数,默认值=0
searchEnableInteger是否可被搜索到
0,否;1,是(默认)

返回参数

参数 说明
code 状态码
serverInfo 创建成功的圈组服务器详细信息

serverInfo 中的参数说明

参数 说明
serverId 圈组服务器 ID,唯一标识
name 圈组服务器名称
icon 圈组服务器图标
custom 自定义扩展
owner 圈组服务器创建者账号
memberNumber 圈组服务器成员数量
inviteMode 圈组服务器邀请入群模式,即是否需要被邀请人的同意
applyMode 圈组服务器的申请入群模式,即是否需要创建者或管理员的同意
channelNumber 圈组服务器中的频道数量
validFlag 是否有效:0-无效,1-有效,如果服务器被删除则为无效
createTime 创建时间
updateTime 更新时间

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49****803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/qchat/createServer.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "serverInfo": {
    "serverId": 123, //服务器唯一标识
    "name": "name", //名称
    "icon": "icon", //图标 
    "custom": "custom", //自定义扩展
    "owner": "zhangsan", //所有者的用户帐号
    "memberNumber": 1, //成员数量
    "inviteMode": 0, //邀请模式
    "applyMode": 0, //申请模式
    "channelNumber": 0, //频道数量
    "validFlag": 1, //有效标志:0-无效,1-有效
    "createTime": 1234, //创建时间
    "updateTime": 1234 //更新时间
  }
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "accid not exist!" 
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 非法操作或无权限
  • 检查是否已开通圈组功能
  • 如已开通安全通,检查服务器资料(名称和图标等)是否包含违规或敏感信息。如果存在违规或敏感信息,可能被安全通的内容审核判定为“不通过”
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
431 HTTP重复请求 -
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码