getProfile

最后更新时间 2026-04-17

getProfile(options) 用于获取指定好友的资料详情与关系状态。

• 接口标识：friend.getProfile
• 请求类型：FriendGetProfileRequest
• 当前状态：可接入

该接口用于读取已存在好友关系的对端资料，包括展示名称、头像引用、关系状态和可达状态，适合作为好友详情页或会话资料卡的数据来源。

注意事项

• 调用前必须已完成 bootstrap 和 login。
• 该接口面向好友关系，不应混用为组织联系人或陌生人搜索接口。
• 如果目标好友不存在或关系状态不可用，业务方应优先展示明确的空态或错误提示。
• 当前实现阶段为 浅实现，当前可接入状态为 可接入。
• 当前方法已纳入 release/phase0 正式发布承诺。

支持说明

该接口用于四端统一的好友详情查询。

应用能力	Android	iOS	Harmony	PC	发布状态
SDK Wrapper	支持	支持	支持	支持	已纳入 release/phase0

发布基线：

• android: Android 8.0+ (API 26)
• ios: iOS 15+
• harmony: HarmonyOS NEXT API 12+
• pc: Host OS with supported native bridge runtime

输入

该接口接收 FriendGetProfileRequest 请求对象，字段定义如下。

名称	数据类型	是否必填	默认值	描述
friend_id	String	是	-	要查询的好友标识。

说明

请求对象由业务方传入，用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象，但字段语义必须与 FriendGetProfileRequest 保持一致。

输出

该接口成功后返回 FriendGetProfileResponse 业务结果，字段定义如下。

名称	数据类型	描述
friend_id	String	好友的唯一标识。
display_name	String	好友展示名称。
avatar_reference	Option<String>	好友头像资源引用；浅实现以 avatar://friend-... 形式返回。
relationship_state	String	当前账号与该好友的关系状态。
availability_state	String	好友当前可达或在线状态。
remark	Option<String>	当前账号对该好友设置的备注名；未设置时为空。
source_state	String	该好友资料的来源状态；当前浅实现来自 address-book 语义。

状态与前置条件

• 调用前置条件：runtime.bootstrap、auth.login
• 当前 SDK 状态要求：当前用户已登录，且目标好友标识有效。
• 调用成功后状态：成功后不会改变 SDK 状态。
• 建议后续调用：friend.list、conversation.getSnapshot

示例代码

平台调用示例

平台	正式入口	绑定方式	错误返回方式
Android	com.robin.sdk.RobinSdk	kotlin-java-facade	result-error-object
iOS	RobinSdk	swift-facade	throws-result-enum
Harmony	RobinSdk	arkts-js-facade	result-code-object
PC	robin_sdk_bridge	native-bridge-facade	bridge-error-code

说明

当前仓库尚未提供该方法的真实平台 facade 调用代码片段。你可以先根据以下真实入口信息接入平台 wrapper；后续如补充 docs/examples/<platform>/friend-get-profile.*，页面会自动渲染对应平台示例。

错误码

错误码	描述	排查建议
not_found	当前方法可能返回该失败标识。	结合调用前置条件、平台支持情况和输入参数继续排查。
action_not_enabled	当前接口能力未开放，或当前发布范围不支持该调用。	检查接口是否已纳入当前发布范围，并确认目标平台已支持该能力。