功能说明
购买云端搜索插件，可以通过本接口，隐藏搜索对象(用户/群组/群成员)，避免该对象被搜索出来。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/im_open_search/set_visibility?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | 当前仅支持中国站，SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com其他站点暂不支持。 |
v4/im_open_search/set_visibility | 隐藏搜索对象接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
2次/秒。
请求包示例
{"SetType":1,"UserID":"test","IsDisable":true}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
SetType | Integer | 必填 | 搜索对象类型： 1=用户搜索。 2=群组搜索。 3=群成员搜索。 |
UserID | String | 选填 | 需要隐藏的用户 UserID，SetType为1和3时需要。 |
GroupID | String | 选填 | 需要隐藏的群组 GroupID，SetType为1和2时需要。 |
IsDisable | Bool | 选填 | 默认为 false，true 表示隐藏对应搜索对象，false 表示显示对应搜索对象。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败。 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败。 |
ErrorInfo | String | 错误信息。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 描述 |
27003 | 请求参数异常，请根据错误提示排查原因。 |
27004 | 服务内部异常，重试仍有问题可以通过工单联系我们。 |
60018 | 请求过于频繁，请稍后重试。 |
60020 | 云端搜索套餐包过期或者响应搜索场景没有开启，请检查后重试。 |
