API 参考
圈组

批量查询服务器信息

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

云信服务端支持传入最多 200 个服务器 ID 查询这些服务器的配置信息,包括包含的频道数量、邀请模式、申请模式等。

URL

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

请求中Headers的设置请参考接口概述

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
serverIds
String[]
服务器 ID 列表,JSON Array 格式,最多可包含 200 个服务器 ID

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49**0803mgq3" -H "Nonce: 4tggge**w323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverIds=%5B%22123%22%2C%22234%22%5D' 'https://api.netease.im/nimserver/qchat/getServers.action'

返回示例

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "serverInfos": [
    {
      "owner": "wm1",  //服务器所有者
      "validFlag": 1, //有效标志:0-无效,1-有效
      "channelNumber": 3, //频道数量
      "reorderWeight": 100, // 服务器搜索结果的自定义排序权重值
      "inviteMode": 1,  //邀请模式
      "updateTime": 1655173709592, //更新时间
      "serverId": 2671906, //服务器唯一标识
      "memberNumber": 1, // 成员数量
      "applyMode": 0, //申请模式
      "categoryNumber": 0, //频道分组数量
      "createTime": 1655125980974, //创建时间
      "name": "member_test_server" //名称
    }
  ],
  "code": 200
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限 检查是否已开通圈组功能
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的服务器 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码