Appearance
resolveDirectory
最后更新时间 2026-04-17
resolveDirectory(options) 用于按组织目录解析目标部门或目录实体,并返回当前目录节点状态。
- 接口标识:
contactOrg.resolveDirectory - 请求类型:
ContactDirectoryResolveRequest - 当前状态:可接入
该接口用于组织通讯录浏览场景,帮助业务方从部门或目录节点切入,逐级解析当前目录范围,为目录树浏览、部门展开或组织选人场景提供基础数据。
注意事项
- 调用前必须已完成 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
输入
该接口接收 ContactDirectoryResolveRequest 请求对象,字段定义如下。
| 名称 | 数据类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
user_id | String | 是 | - | 需要执行目录解析的用户标识。 |
department_id | String | 是 | - | 用于目录解析的部门标识。 |
说明
请求对象由业务方传入,用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象,但字段语义必须与 ContactDirectoryResolveRequest 保持一致。
输出
该接口成功后返回 ContactDirectoryResolveResponse 业务结果,字段定义如下。
| 名称 | 数据类型 | 描述 |
|---|---|---|
resolved_entity_id | String | 目录解析后得到的实体标识。 |
department_id | String | 解析结果关联的部门标识。 |
directory_state | String | 当前目录解析状态。 |
status | String | 接口处理状态;浅实现返回 resolved。 |
状态与前置条件
- 调用前置条件:
runtime.bootstrap、auth.login - 当前 SDK 状态要求:当前用户会话有效,且具备访问目标组织目录的上下文。
- 调用成功后状态:成功后不会改变 SDK 状态,返回当前目录节点的解析结果。
- 建议后续调用:
contact.search
示例代码
平台调用示例
| 平台 | 正式入口 | 绑定方式 | 错误返回方式 |
|---|---|---|---|
| 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>/contact-org-resolve-directory.*,页面会自动渲染对应平台示例。
错误码
| 错误码 | 描述 | 排查建议 |
|---|---|---|
not_found | 当前方法可能返回该失败标识。 | 结合调用前置条件、平台支持情况和输入参数继续排查。 |
action_not_enabled | 当前接口能力未开放,或当前发布范围不支持该调用。 | 检查接口是否已纳入当前发布范围,并确认目标平台已支持该能力。 |