tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

Android&iOS&Windows&Mac

PDF
聚焦模式
字号
最后更新时间: 2025-03-27 10:53:48

搜索云端用户

功能描述

您可以通过用户 ID、昵称、性别等信息来搜索云端用户,以便快速找到所需的用户资料。此功能适用于需要查找特定用户信息的场合,例如在熟人社交场景中查找用户以加好友,或者在陌生人社交场景中查找用户以关注。
说明:
用户云端搜索功能仅 8.4 及以上版本支持。
云端搜索功能仅对专业版 Plus 和企业版客户开放,购买专业版 Plus 和企业版 后可使用;体验版支持一定额度免费试用,有效期一个月。
如果您没有开通该服务,调用接口会返回 60020 错误码。

搜索云端用户接口

调用接口 searchUsers (Java / Swift / Objective-C / C++) 可以搜索云端用户资料,该接口返回的是云端存储的用户资料,包括好友和非好友资料,您可以调用 checkFriend (Java / Swift / Objective-C / C++) 接口来判断是否为好友。
V2TIMUserSearchParam 的参数说明如下:
参数
含义
说明
keywordList
关键字列表
关键字列表最多支持 5 个,keyword 会自动匹配用户 ID、昵称。
keywordListMatchType
指定关键字列表匹配类型
可设置为 “或” 关系搜索,或 “与” 关系搜索。取值分别为 V2TIM_KEYWORD_LIST_MATCH_TYPE_ORV2TIM_KEYWORD_LIST_MATCH_TYPE_AND。默认为 “或” 关系搜索。
gender
用户性别
如果不设置,默认男性和女性都会返回。
minBirthday
用户最小生日
如果不设置,默认值为 0。
maxBirthday
用户最大生日
如果不设置,默认 birthday >= minBirthday 的用户都会返回。
searchCount
搜索的数量
必须大于 0,最大支持 100,默认 20。
searchCursor
搜索的游标
搜索的起始位置,第一次填写空字符串,续拉时填写上一次返回的 V2TIMUserSearchResult 中的 searchCursor

用户搜索结果类

消息搜索结果类为 V2TIMUserSearchResultJava / Swift / Objective-C / C++)。参数说明如下:
参数
含义
说明
isFinished
搜索是否已完成
是否已经返回全部满足搜索条件的用户列表。
totalCount
搜索结果总数
满足搜索条件的用户总数量。
nextCursor
续拉的游标
调用搜索接口续拉时需要填的游标。
userList
用户列表
当前一次云端搜索返回的用户列表。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMUserSearchParam searchParam = new V2TIMUserSearchParam();
searchParam.setKeywordList(keywordList);
searchParam.setKeywordListMatchType(param.V2TIM_KEYWORD_LIST_MATCH_TYPE_OR);
searchParam.setSearchCount(20);
searchParam.setSearchCursor("");

V2TIMManager.getInstance().searchUsers(searchParam, new V2TIMValueCallback<V2TIMUserSearchResult>() {
@Override
public void onSuccess(V2TIMUserSearchResult userSearchResult) {
// 搜索云端用户资料成功
}

@Override
public void onError(int code, String desc) {
// 搜索云端用户资料失败
}
});
let param = V2TIMUserSearchParam()
param.gender = .V2TIM_GENDER_UNKNOWN;
param.keywordList = ["keyword1", "keyword2"];
param.keywordListMatchType = .V2TIM_KEYWORD_LIST_MATCH_TYPE_OR;
param.searchCount = 20;
param.searchCursor = "";
V2TIMManager.shared.searchUsers(param: param) { searchResult in
// 搜索云端用户资料成功
} fail: { code, desc in
// 搜索云端用户资料失败
}
V2TIMUserSearchParam *param = [[V2TIMUserSearchParam alloc] init];
param.gender = V2TIM_GENDER_UNKNOWN;
param.keywordList = @[@"keyword1", @"keyword2"];
param.keywordListMatchType = V2TIM_KEYWORD_LIST_MATCH_TYPE_OR;
param.searchCount = 20;
param.searchCursor = @"";
[[V2TIMManager sharedInstance] searchUsers:param succ:^(V2TIMUserSearchResult *searchResult) {
// 搜索云端用户资料成功
} fail:^(int code, NSString *desc) {
// 搜索云端用户资料失败
}];

template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMUserSearchParam searchParam;
searchParam.keywordList = keywordList;
param.keywordListMatchType = V2TIM_KEYWORD_LIST_MATCH_TYPE_OR;
param.searchCount = 20;
param.searchCursor = "";

auto callback = new ValueCallback<V2TIMUserSearchResult>{};
callback->SetCallback(
[=](const V2TIMUserSearchResult& userSearchResult) {
// 搜索云端用户资料成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 搜索云端用户资料失败
delete callback;
});

V2TIMManager::GetInstance()->SearchUsers(searchParam, callback);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈