Appearance
search
最后更新时间 2026-04-17
search(options) 用于在指定组织范围内搜索联系人,并返回命中的联系人条目。
- 接口标识:
contactOrg.search - 请求类型:
OrgContactSearchRequest - 当前状态:可接入
该接口适用于组织选人、发起会话、添加协作者等场景。业务方可以在指定组织内按关键字查询联系人,并结合命中结果跳转到资料页或选人流程。
注意事项
- 调用前必须已完成 bootstrap 和 login。
- 搜索范围受 org_id 约束;如果需要目录浏览,应优先调用 resolveDirectory。
- 该接口返回的是组织联系人命中结果,不等价于全局搜索。
- 当前实现阶段为 浅实现,当前可接入状态为 可接入。
- 当前方法已纳入
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
输入
该接口接收 OrgContactSearchRequest 请求对象,字段定义如下。
| 名称 | 数据类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
org_id | String | 是 | - | 组织范围标识,仅在该组织内执行联系人搜索。 |
keyword | String | 是 | - | 联系人搜索关键词,支持精确匹配或关键字匹配。 |
说明
请求对象由业务方传入,用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象,但字段语义必须与 OrgContactSearchRequest 保持一致。
输出
该接口成功后返回 OrgContactSearchResponse 业务结果,字段定义如下。
| 名称 | 数据类型 | 描述 |
|---|---|---|
entries | Vec<OrgContactEntry> | 命中的组织联系人列表。 |
status | String | 搜索结果状态;ready 表示结果已经可用。 |
OrgContactEntry
来源:src/public_api/contact_org/mod.rs
| 名称 | 数据类型 | 描述 |
|---|---|---|
contact_id | String | 命中的组织联系人标识。 |
display_name | String | 命中联系人的展示名称。 |
org_id | String | 命中联系人所属的组织标识。 |
状态与前置条件
- 调用前置条件:
runtime.bootstrap、auth.login - 当前 SDK 状态要求:当前用户会话有效,且具备目标组织的访问上下文。
- 调用成功后状态:成功后不会改变 SDK 状态,返回当前搜索结果快照。
- 建议后续调用:
friend.getProfile、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>/contact-org-search.*,页面会自动渲染对应平台示例。
错误码
| 错误码 | 描述 | 排查建议 |
|---|---|---|
action_not_enabled | 当前接口能力未开放,或当前发布范围不支持该调用。 | 检查接口是否已纳入当前发布范围,并确认目标平台已支持该能力。 |