修改服务器自定义排序值

更新时间: 2024/03/15 14:31:51

云信 IM 服务端提供如下 API 修改服务器的自定义排序权重值。配合 SDK 相关方法的调用,可实现搜索结果中匹配项(服务器)的自定义排序。

SDK 端侧的相关说明请参见:

目前仅服务端支持自定义排序权重值的修改。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数类型必须示例说明
reorderWeightInfo String "{"100":1, "200":3}"
用于修改服务器对应的自定义排序权重值的 JSON 数据:{serverId1:weight1, serverId2:weight2, serverId3:weight3,serverId4:weight4},其中:
  • serverId:圈组服务器 ID
  • weight:排序的权重,范围为[0-LongMax]
该参数需配合 SDK 支持圈组功能的各端的排序规则参数生效。如排序规则字段为默认倒序,则匹配的服务器列表以权重值倒序排列,相同权重值的服务器按serverId倒序排列。如排序规则为正序,则按权重值正序排序,相同权重的按serverId倒序排列。

调用该 API 单次可修改权重值的服务器数量上限默认为 10。如需调整该上限,请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。

返回参数

参数 类型 说明
failedItems Long 权重值修改失败的服务器 ID

示例

cURL请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9****0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d '{"100":1, "200":3}' 'http://api.netease.im/nimserver/qchat/batchUpdateServerReorderWeight.action'

返回示例

请求成功的返回示例如下:

json
"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "failedItems": [
        2639099
    ]
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL请求示例
  • 返回示例
  • 状态码