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-05-23 14:31:46

功能描述

Chat SDK 支持好友的管理,用户可以主动添加、删除好友,也可以设置仅针对好友才能发送消息。

获取好友列表

Chat SDK 支持好友关系链逻辑,您可以调用 getFriendList (Java / Swift / Objective-C / C++) 接口获取好友列表。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMManager.getFriendshipManager().getFriendList(new V2TIMValueCallback<List<V2TIMFriendInfo>>() {
@Override
public void onSuccess(List<V2TIMFriendInfo> v2TIMFriendInfos) {
// 获取好友列表成功
}

@Override
public void onError(int code, String desc) {
// 获取好友列表失败
}
});
V2TIMManager.shared.getFriendList { infoList in
infoList.forEach { item in
print( item.description)
}
} fail: { code, desc in
print( "getFriendList fail, \\(code), \\(desc)")
}
// 获取好友列表
[[V2TIMManager sharedInstance] getFriendList:^(NSArray<V2TIMFriendInfo *> *infoList) {
// 获取好友列表成功
} 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_;
};

auto callback = new ValueCallback<V2TIMFriendInfoVector>{};
callback->SetCallback(
[=](const V2TIMFriendInfoVector& friendInfoList) {
// 获取好友列表成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 获取好友列表失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->GetFriendList(callback);


添加好友

您可以调用 addFriend (Java / Swift / Objective-C / C++) 接口添加好友。
示例代码如下:
Java
Swift
Objective-C
C++
// 添加好友
V2TIMFriendAddApplication application = new V2TIMFriendAddApplication("userA");
application.setAddType(V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH);
V2TIMManager.getFriendshipManager().addFriend(application, new V2TIMValueCallback<V2TIMFriendOperationResult>() {
@Override
public void onSuccess(V2TIMFriendOperationResult v2TIMFriendOperationResult) {
// 添加好友请求成功
}

@Override
public void onError(int code, String desc) {
// 添加好友失败
}
});
let application = V2TIMFriendAddApplication()
application.userID = "userA"
application.friendRemark = "remark swift"
application.friendGroup = "swift"
application.addWording = "this is an addwording from swift api"
application.addSource = "swift"
application.addType = .V2TIM_FRIEND_TYPE_BOTH
V2TIMManager.shared.addFriend(application: application) { result in
print( "addFriend succ, \\(result.description)")
} fail: { code, desc in
print( "addFriend fail, \\(code), \\(desc)")
}
// 添加好友
V2TIMFriendAddApplication *application = [[V2TIMFriendAddApplication alloc] init];
application.userID = @"userA";
application.addType = V2TIM_FRIEND_TYPE_BOTH;
[[V2TIMManager sharedInstance] addFriend:application succ:^(V2TIMFriendOperationResult *result) {
// 添加好友请求成功
} 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_;
};

V2TIMFriendAddApplication application;
application.userID = u8"userA";
application.addType = V2TIMFriendType::V2TIM_FRIEND_TYPE_BOTH;

auto callback = new ValueCallback<V2TIMFriendOperationResult>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResult& friendOperationResult) {
// 添加好友请求成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 添加好友失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->AddFriend(application, callback);

根据对方用户资料中的加好友需要验证与否,可以分为两种处理流程:

第一种:加好友不需要对方验证

1. 用户 A 和 B 调用 setFriendListener 设置关系链监听器。
2. 用户 B 通过 setSelfInfo 函数里的 allowType (Java / Swift / Objective-C / C++) 字段设置为 “加好友不需要验证(V2TIM_FRIEND_ALLOW_ANY)”。
3. 用户 A 调用 addFriend 申请添加 B 为好友即可添加成功。添加成功后,按照申请参数 V2TIMFriendAddApplicationaddType 的设置有两种情况:
如果设置为双向好友 (V2TIM_FRIEND_TYPE_BOTH) ,则用户 A 和 B 都会收到 onFriendListAdded (Java / Swift / Objective-C / C++) 回调;
如果设置为单向好友(V2TIM_FRIEND_TYPE_SINGLE),则只有用户 A 收到 onFriendListAdded 回调。

第二种:加好友需要通过对方验证

1. 用户 A 和 B 调用 setFriendListener 设置关系链监听。
2. 用户 B 通过 setSelfInfo 函数里的 allowType 字段设置为 “加好友需要验证(V2TIM_FRIEND_NEED_CONFIRM)”。
3. 用户 A 调用 addFriend 申请添加 B 为好友,接口的成功回调参数中 resultCode 返回 30539,表示需要等待用户 B 的验证。同时 A 和 B 都会收到 onFriendApplicationListAdded (Java / Swift / Objective-C / C++) 的回调。
4. 用户 B 会收到 onFriendApplicationListAdded 的回调,当参数 V2TIMFriendApplication 中的 typeV2TIM_FRIEND_APPLICATION_COME_IN 时,可以选择接受或者拒绝:
B 调用 acceptFriendApplication (Java / Swift / Objective-C / C++) 接受好友请求。如果参数接受类型为仅同意加单向好友(V2TIM_FRIEND_ACCEPT_AGREE)时:
A 会收到 onFriendListAdded 回调,说明单向加好友成功。
B 会收到 onFriendApplicationListDeleted (Java / Swift / Objective-C / C++) 回调,此时 B 成为 A 的好友,但 A 仍不是 B 的好友。
B 调用 acceptFriendApplication 接受好友请求,如果参数接受类型为同意加双向好友时(V2TIM_FRIEND_ACCEPT_AGREE_AND_ADD),A 和 B 都会收到 onFriendListAdded 回调,说明互相加好友成功。
B 调用 refuseFriendApplication (Java / Swift / Objective-C / C++) 拒绝好友请求,双方都会收到 onFriendApplicationListDeleted 回调。
说明:
您还可以通过调用 getFriendApplicationList(Java / Swift / Objective-C / C++)获取暂未处理的好友申请列表,包括发起的好友申请和收到的好友申请。但是请注意,已经处理的好友申请不能再拉取到。最多支持拉取 100 条。

删除好友

您可以调用 deleteFromFriendList (Java / Swift / Objective-C / C++) 接口删除好友关系。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> friendIDList = new ArrayList<>();
friendIDList.add("userA");
V2TIMManager.getFriendshipManager().deleteFromFriendList(friendIDList, V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 删除好友成功
}

@Override
public void onError(int code, String desc) {
// 删除好友失败
}
});
V2TIMManager.shared.deleteFromFriendList(userIDList: ["userID"], deleteType: .V2TIM_FRIEND_TYPE_BOTH) { resultList in
resultList.forEach { item in
// V2TIMFriendOperationResult
print( item.description)
}
} fail: { code, desc in
print( "deleteFromFriendList fail, \\(code), \\(desc)")
}
// 删除好友
[[V2TIMManager sharedInstance] deleteFromFriendList:@[@"userA"] deleteType:V2TIM_FRIEND_TYPE_BOTH succ:^(NSArray<V2TIMFriendOperationResult *> *resultList) {
// 删除好友成功
} 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_;
};

V2TIMStringVector userIDList;
userIDList.PushBack(u8"userA");
V2TIMFriendType deleteType = V2TIMFriendType::V2TIM_FRIEND_TYPE_BOTH;

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 删除好友成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 删除好友失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->DeleteFromFriendList(userIDList, deleteType, callback);

检查好友关系

您可以调用 checkFriend (Java / Swift / Objective-C / C++) 接口检查好友关系。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMManager.getFriendshipManager().checkFriend(userIDList, V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH, new V2TIMValueCallback<List<V2TIMFriendCheckResult>>() {
@Override
public void onSuccess(List<V2TIMFriendCheckResult> v2TIMFriendCheckResults) {
// 检查好友关系成功
for (V2TIMFriendCheckResult checkResult : v2TIMFriendCheckResults) {
// 用户 ID
String userID = checkResult.getUserID();
// 用户和自己的好友关系
int relationType = checkResult.getResultType();
}
}

@Override
public void onError(int code, String desc) {
// 检查好友关系失败
}
});
// 检查 user1 和自己的好友关系
V2TIMManager.shared.checkFriend(userIDList: ["user1"], checkType: .V2TIM_FRIEND_TYPE_BOTH) { resultList in
resultList.forEach { item in
// V2TIMFriendCheckResult
print( item.description)
}
} fail: { code, desc in
print( "checkFriend fail, \\(code), \\(desc)")
}
// 检查 user1 和自己的好友关系
[[V2TIMManager sharedInstance] checkFriend:@[@"user1"] checkType:V2TIM_FRIEND_TYPE_BOTH succ:^(NSArray<V2TIMFriendCheckResult *> *resultList) {
// 检查好友关系成功
for (V2TIMFriendCheckResult *result in resultList) {
// 用户 ID
NSString *userID = result.userID;
// 用户和自己的好友关系
V2TIMFriendRelationType relationType = result.relationType;
}
} 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_;
};

V2TIMStringVector userIDList;
userIDList.PushBack(u8"userA");
V2TIMFriendType checkType = V2TIMFriendType::V2TIM_FRIEND_TYPE_BOTH;

auto callback = new ValueCallback<V2TIMFriendCheckResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendCheckResultVector& friendCheckResultList) {
// 检查好友关系成功
for (size_t i = 0; i < friendCheckResultList.Size(); ++i) {
const V2TIMFriendCheckResult& friendCheckResult = friendCheckResultList[i];
// 用户 ID
V2TIMString userID = friendCheckResult.userID;
// 用户 ID
V2TIMFriendRelationType relationType = friendCheckResult.relationType;
}
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 检查好友关系失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->CheckFriend(userIDList, checkType, callback);

查询和修改好友资料

您可以调用 getFriendsInfo (Java / Swift / Objective-C / C++) 接口查询指定的好友资料。
从回调信息中通过 V2TIMFriendInfoResultrelation 字段可以得到该用户与自己的关系:
V2TIMFriendInfoResult.relation
与自己的关系
V2TIM_FRIEND_RELATION_TYPE_NONE
不是好友。
V2TIM_FRIEND_RELATION_TYPE_BOTH_WAY
互为好友。
V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST
对方在我的好友列表中。
V2TIM_FRIEND_RELATION_TYPE_IN_OTHER_FRIEND_LIST
我在对方的好友列表中。
说明
好友资料更新时,后台会主动向 SDK 发送系统通知,因此好友资料可以实时更新。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("userA");
V2TIMManager.getFriendshipManager().getFriendsInfo(userIDList, new V2TIMValueCallback<List<V2TIMFriendInfoResult>>() {
@Override
public void onSuccess(List<V2TIMFriendInfoResult> v2TIMFriendInfoResults) {
// 获取好友资料成功
}

@Override
public void onError(int code, String desc) {
// 获取好友资料失败
}
});
V2TIMManager.shared.getFriendsInfo(userIDList: ["userID1", "userID2"]) { resultList in
resultList.forEach { item in
// V2TIMFriendInfoResult
print( item.description)
}
} fail: { code, desc in
print( "getFriendsInfo fail, \\(code), \\(desc)")
}
// 获取好友资料
[[V2TIMManager sharedInstance] getFriendsInfo:@[@"userA"] succ:^(NSArray<V2TIMFriendInfoResult *> *resultList) {
// 获取好友资料成功
} 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_;
};

V2TIMStringVector userIDList;
userIDList.PushBack(u8"userA");

auto callback = new ValueCallback<V2TIMFriendInfoResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendInfoResultVector& friendInfoResultList) {
// 获取好友资料成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 获取好友资料成功
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->GetFriendsInfo(userIDList, callback);
您可以调用 setFriendInfo (Java / Swift / Objective-C / C++) 接口修改好友资料,包括好友备注、好友自定义字段、好友分组等字段。详情可参考 V2TIMFriendInfo(Java / Swift / Objective-C / C++) 类定义。
如果要修改好友自定义字段,您必须提前在控制台配置好该字段,配置路径:Applications > Your App > Chat > Configuration > Custom User Field。
注意:
最多可设置 20 个好友自定义字段。字段创建后,该字段将不可删除,也无法修改字段名与字段类型。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMFriendInfo friendInfo = new V2TIMFriendInfo();
// userA 为自己的好友
friendInfo.setUserID("userA");
friendInfo.setFriendRemark("friendRemark");
V2TIMManager.getFriendshipManager().setFriendInfo(friendInfo, new V2TIMCallback() {
@Override
public void onSuccess() {
// 设置好友资料成功
}

@Override
public void onError(int code, String desc) {
// 设置好友资料失败
}
});
let friendInfo = V2TIMFriendInfo()
friendInfo.userID = "userA"
friendInfo.friendRemark = "friendRemark"
friendInfo.friendCustomInfo = ["key1": "11".data(using: .utf8) ?? Data()]
V2TIMManager.shared.setFriendInfo(info: friendInfo) {
print( "setFriendInfo succ")
} fail: { code, desc in
print( "setFriendInfo fail, \\(code), \\(desc)")
}
// 设置好友资料
V2TIMFriendInfo *friendInfo = [[V2TIMFriendInfo alloc] init];
friendInfo.userID = @"userA"; // userA 为自己的好友
friendInfo.friendRemark = @"friendRemark";
[[V2TIMManager sharedInstance] setFriendInfo:friendInfo succ:^{
// 设置好友资料成功
} fail:^(int code, NSString *desc) {
// 设置好友资料失败
}];
class Callback final : public V2TIMCallback {
public:
using SuccessCallback = std::function<void()>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

Callback() = default;
~Callback() override = default;

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

void OnSuccess() override {
if (success_callback_) {
success_callback_();
}
}
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_;
};

V2TIMFriendInfo info;
info.userID = u8"userA";
info.friendRemark = u8"friendRemark";
info.modifyFlag = V2TIMFriendInfoModifyFlag::V2TIM_FRIEND_INFO_MODIFY_FLAG_REMARK;

auto callback = new Callback{};
callback->SetCallback(
[=]() {
// 设置好友资料成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 设置好友资料失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->SetFriendInfo(info, callback);

设置只能给好友发消息

在客服场景中,如果用户需要先加客服为好友才能进行沟通非常不方便,因此 SDK 在发送单聊消息的时候,默认不检查好友关系。 如需实现“先加好友,再发消息” 的交互体验,您可以登录控制台修改 Relationship Check。开启后,用户只能给好友发送消息,当用户给非好友发消息时,SDK 会报 20009 错误码。配置路径为:Applications > Your App > Chat > Configuration > Login and Message > Relationship Check。



帮助和支持

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

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

文档反馈