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 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

React Native

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

功能描述

搜索云端用户,支持根据关键词进行快速查找。用户可以通过此接口迅速定位已知用户,如好友或关注的联系人;同时,也可以利用关键词进行新用户的发现,拓展社交圈或寻找感兴趣的用户。
说明:
云端搜索功能仅对专业版 Plus 和企业版客户开放,购买专业版 Plus 和企业版 后可使用;体验版支持一定额度免费试用,有效期一个月。
搜索云端用户功能 v3.5.0 起支持。
搜索范围:根据关键词对所有用户的昵称 nick 进行模糊搜索匹配, 对所有用户的 userID 进行精准搜索匹配。
获取的用户列表中的资料是不完整的(仅包括头像 avatar、昵称 nick、用户账号 userID、性别 gender、生日 birthday、个性签名 selfSignature 等,能够满足用户搜索结果列表的渲染需求,不包含自定义字段),若要查询详细用户资料,可参考:getUserProfile
单次最大搜索数结果量为 100 条。
此接口云端限频 2次/秒, 本地接口调用默认限制 20次/5秒。

搜索云端用户

接口
chat.searchCloudUsers(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
keywordList
Array
required
关键字列表,最多支持 5 个。
keywordListMatchType
String | undefined
关键字列表匹配类型:
or:“或”关系搜索(默认)
and:“与”关系搜索
gender
String | undefined
用户性别,不传入时默认搜索所有性别用户。性别表示:
TencentCloudChat.TYPES.GENDER_FEMALE 女性
TencentCloudChat.TYPES.GENDER_MALE 男性
miniBirthday
Number | undefined
用户最小生日,如 19900101。
maxBirthday
Number | undefined
用户最大生日,与 miniBirthday 同时设置时则必须大于等于 miniBirthday,如 20240101。
cursor
String | undefined
每次搜索云端用户的起始位置。第一次搜索时不要传入 cursor,继续搜索时填入上次调用 searchCloudUsers 接口返回的 cursor 的值。
count
Number | undefined
每次搜索云端用户结果的数量,默认值为 20, 最大值为100。
返回值
Promise
Name
Type
Description
totalCount
Number
满足搜索条件的用户总数。
searchResultList
Array
满足搜索条件的用户资料 Profile 列表,仅包括头像 avatar、昵称 nick、用户账号 userID、性别 gender、生日 birthday、个性签名 selfSignature 等信息,能够满足用户搜索结果列表的渲染需求,不包含自定义字段,若要查询详细用户资料,可参考:getUserProfile
cursor
String
调用搜索接口续拉时需要填的游标。
示例
// 搜索指定关键字列表和出生时间范围搜索
// - 搜索用户里出现 'test' 或 'user',且用户出生时间在 20240101 之前的用户
let promise = chat.searchCloudUsers({
keywordList: ['test', 'user'],
maxBirthday: 20240101,
});
promise.then(function(imResponse) {
// 搜索用户成功
const { totalCount, cursor, searchResultList } = imResponse.data;
console.log(totalCount); // 满足搜索条件的用户总数量
console.log(cursor); // 下一次云端搜索的起始位置, 如果没有表示搜索结果拉取完成
console.log(searchResultList); // 满足搜索条件的用户列表,分页返回分组结果,每页最大返回 100, count 设定
for (let i = 0; i < searchResultList.length; i++) {
const profileItem = searchResultList[i];
const { userID, nick, gender, avatar } = profileItem;
console.log(userID); // 用户 ID
console.log(nick); // 用户昵称
console.log(gender); // 用户性别
console.log(avatar); // 用户头像
}
}).catch(function(imError) {
console.error(imError); // 搜索用户失败
});


帮助和支持

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

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

文档反馈