服务端 API

概述

关系模块面向可信后端服务，用于管理 OpenIM 用户之间的好友关系、好友申请、好友资料扩展和黑名单等用户关系数据。它属于用户关系能力，不放在内容审核模块中；黑名单虽然有治理含义，但数据归属仍是用户关系。

能力范围

关系模块的资源对象描述用户之间的关系状态，包括好友关系、好友申请和黑名单。黑名单虽然有治理含义，但对象归属仍在关系模块。

FriendInfo 表示当前用户与某个好友之间的关系资料。

FriendRequestInfo 表示一条好友申请记录。

字段	类型	说明
fromUserID	string	申请发起用户 ID。
fromNickname	string	申请发起用户昵称。
fromFaceURL	string	申请发起用户头像 URL。
toUserID	string	申请接收用户 ID。
toNickname	string	申请接收用户昵称。
toFaceURL	string	申请接收用户头像 URL。
handleResult	int	处理结果，参见 `FriendRequestResult`。
reqMsg	string	申请说明。
createTime	int64	申请创建时间。
handlerUserID	string	处理申请的用户 ID。
handleMsg	string	处理说明。
handleTime	int64	申请处理时间。
ex	string	好友申请扩展字段。

BlackInfo 表示用户黑名单关系。

字段	类型	说明
ownerUserID	string	黑名单所有者用户 ID。
createTime	int64	加入黑名单时间。
blackUserInfo	object	被加入黑名单的用户公开资料，结构为用户模块的 `PublicUserInfo`。
addSource	int	加入黑名单来源，参见 `AddSource`。
operatorUserID	string	操作者用户 ID。
ex	string	黑名单扩展字段。

AddSource 表示好友关系或黑名单关系的建立来源。

值	名称	说明
1	`BecomeFriendByImport`	由管理员或服务端导入。
2	`BecomeFriendByApply`	由好友申请建立。

FriendRequestResult 表示好友申请的处理结果。

好友关系应由业务后端统一判断是否允许建立、删除或导入。调用 OpenIM 前，先确认两个用户在业务系统中存在，并记录操作者、来源和原因；需要风控时可以结合回调或业务审批流程。

黑名单应作为用户关系能力处理。产品上可以在内容治理入口中展示黑名单相关链接，但接口文档应保留在关系模块，避免用户误以为它是频道或消息审核能力。