getProfile

最后更新时间 2026-04-17

getProfile(options) 用于获取当前账号的基础资料与当前资料状态。

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

该接口主要用于在用户登录后读取当前账号的展示信息、资料状态和所属工作区上下文，适合作为首页或个人中心首屏的基础资料来源。

注意事项

• 调用前必须已完成 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

输入

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

名称	数据类型	是否必填	默认值	描述
user_id	String	是	-	要读取资料的用户标识。

说明

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

输出

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

名称	数据类型	描述
account_id	String	当前账号的唯一标识；已认证时来自当前会话用户。
display_name	String	当前账号的展示名称；浅实现会基于 account_id 生成默认昵称。
avatar_reference	Option<String>	当前账号头像资源引用；浅实现以 avatar://<account_id> 形式返回。
status	String	当前账号在线或可用状态；浅实现固定返回 online。
organization_label	Option<String>	当前账号所属组织或工作台标签；浅实现固定为 Robin Workspace。
profile_completeness	String	资料完整度状态；浅实现固定返回 complete。
last_refresh_state	String	最近一次资料刷新来源；已认证会话返回 server-synced，否则返回 local-cache。

状态与前置条件

• 调用前置条件：runtime.bootstrap、auth.login
• 当前 SDK 状态要求：当前用户会话有效。
• 调用成功后状态：成功后不会改变 SDK 状态，主要返回当前账号资料快照。
• 建议后续调用：friend.list、contact.resolveDirectory、message.getTimeline

示例代码

平台调用示例

平台	正式入口	绑定方式	错误返回方式
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>/account-get-profile.*，页面会自动渲染对应平台示例。

错误码

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