修改频道自定义排序值
更新时间: 2024/07/17 17:57:34
云信 IM 服务端提供如下 API 修改频道的自定义排序权重值。配合 SDK 相关方法的调用,可实现搜索结果中匹配项(频道)的自定义排序。
SDK 端侧的相关说明请参见:
目前仅 IM 服务端支持自定义排序权重值的修改。
URL
httpPOST http://api.netease.im/nimserver/qchat/batchUpdateChannelReorderWeight.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 示例 | 说明 |
---|---|---|---|---|
serverId | Long | 是 | "2639099" | 频道所在的服务器的 ID |
reorderWeightInfo | String | 是 | "{"100":1, "200":3}" |
用于修改频道对应的自定义排序权重值的 JSON 数据:{channeId1:weight1, channeId2:weight2, channeId3:weight3,channeId4:weight4},其中:
|
调用该 API 单次可修改权重值的频道数量上限默认为 10。如需调整该上限,请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。
返回参数
参数 | 类型 | 说明 |
---|---|---|
failedItems | Long | 权重值修改失败的频道的 ID |
示例
cURL请求示例
curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0******" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55*******" -H "Content-Type: application/x-www-form-urlencoded" -d '{"100":1, "200":3}' 'http://api.netease.im/nimserver/qchat/batchUpdateChannelReorderWeight.action'
返回示例
请求成功的返回示例如下:
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"failedItems": [
2639099
]
}
状态码
该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?