功能简介
根据关键词搜索并发起新的好友添加请求。
使用场景
- 需要主动搜索并添加好友时。
参数说明
输入参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 搜索关键词 | 字符串 | 是 | 可用于搜索的昵称、微信号或手机号。 |
| 附加消息 | 字符串 | 否 | 添加好友时附带的消息内容。 |
| 备注 | 字符串 | 否 | 添加成功后设置的备注。 |
| 权限 | 字符串 | 否 | 添加好友后的权限。 |
| 搜索超时时间 | 整数 | 否 | 搜索好友的等待秒数。 |
输出参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 是否成功 | 布尔值 | 是 | 表示本指令的执行判定结果：调用过程中未抛出异常，且底层未返回明确失败值时为 True；若底层抛出异常或返回明确失败值，则判定为失败。 |
注意事项
- 「是否成功」为执行层判定；好友申请是否成功发出及最终结果，受对方设置、验证状态等因素影响，请以微信客户端实际结果为准。