API 参考
圈组

修改服务器信息

更新时间: 2024/07/17 17:57:35

云信服务端支持修改服务器的配置信息,包括服务器名称、服务器图标、邀请模式等。

URL

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

参数说明

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
accidString操作者的 IM 帐号 操作者需要拥有管理服务器的权限,否则将返回 403 错误码。
serverIdLong服务器 ID
nameString服务器名称,最大长度 64 位字符
iconString服务器图标,最大长度 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 字段说明

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk4**w0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid=zhangsan&name=update' 'http://imtest.netease.im/nimserver/qchat/updateServer.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 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查是否拥有管理服务器的权限
  • 检查服务器资料信息(包括图标和名称等)中是否包含违规或敏感内容。如果已开通安全通且被检测到存在违规或敏感信息,可能会被安全通的内容审核判定为“不通过”
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的账号、服务器 ID 或自定义反垃圾业务 ID (bid)是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 参数说明
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码