openclaw directory¶
支持目录查询的渠道可查询:联系人/对等方、群组,以及 “me”(自身)。
结果用于粘贴到其他命令中,尤其是 openclaw message send --target ...。
常用标志¶
--channel <name>:渠道 ID 或别名。配置了多个渠道时必填;仅配置一个渠道时自动选择。--account <id>:账户 ID(默认:渠道默认值)--json:输出 JSON--limit <n>:对联系人/群组/成员列表的正整数上限
省略 --channel 可自动选择唯一已配置的渠道。显式空值或仅包含空白字符的值会在解析选项时以 --channel must not be blank 失败,发生在命令引导以及目录设置或查询之前。传递未设置 shell 变量的脚本必须省略该标志以请求自动选择。
省略 --account 可选择渠道默认值。显式空值或仅包含空白字符的账户值会在账户设置或查询之前以 --account must not be blank 失败。
--limit 需要正整数。省略 --limit 可使用所选渠道插件的默认值。显式空值或仅包含空白字符的值会被拒绝。
默认输出以表格形式渲染 ID 和名称。空列表结果会列出所查询的渠道和账户。JSON 列表输出使用空数组([])。失败时以非零状态退出,并在 JSON 模式下使用标准 { "ok": false, "error": { "type": "cli_error", "message": "..." } } 信封。
备注¶
- 对于许多渠道,结果由配置支持(允许列表 / 已配置群组),而不是实时提供商目录。
- 在实时查询之前,OpenClaw 仅针对所选渠道和账户解析已配置的 SecretRefs。解析后的凭据仅保留在运行时。插件安装和自动启用写入会保留已编写的引用,而不会持久化运行时默认值。
- WhatsApp 群组列表是实时的。Gateway 查询会复用其拥有的连接。独立命令仅在没有其他进程拥有该账户时打开关联会话。否则它会报告实时群组不可用。
- 已安装的渠道插件可能缺少目录支持。在这种情况下,命令会报告不支持的操作。它不会尝试重新安装或升级插件以添加支持。
将结果用于 message send¶
openclaw directory peers list --channel slack --query "U0"
openclaw message send --channel slack --target user:U012ABCDEF --message "hello"
各渠道的 ID 格式¶
| 渠道 | 目标 ID 格式 |
|---|---|
+15551234567(私聊)、1234567890-1234567890@g.us(群组)、120363123456789@newsletter(频道/Newsletter,仅出站) |
|
| Signal | 已配置的别名会解析为 E.164/UUID 私聊目标或 group:<id> 群组目标 |
| Telegram | @username 或数字聊天 ID;群组使用数字 ID |
| Slack | user:U… 和 channel:C… |
| Discord | user:<id> 和 channel:<id> |
| Matrix(插件) | user:@user:server、room:!roomId:server 或 #alias:server |
| Microsoft Teams(插件) | user:<id> 和 conversation:<id> |
| Zalo(插件) | 用户 ID(Bot API) |
Zalo Personal / zalouser(插件) |
线程 ID(私聊/群组),来自 zca(me、friend list、group list) |
自身(“me”)¶
渠道可能合理地不返回自身身份。这是一个成功的空结果(退出码 0),而不是查询失败。没有自身解析器的渠道会报告该渠道未暴露自身身份,而不会建议排查账户问题:
{
"status": "unavailable",
"channel": "telegram",
"accountId": "default",
"reason": "self-identity-unsupported"
}
当渠道实现了自身查询但未返回身份时,文本输出会列出渠道和账户,并建议检查其配置和身份验证。JSON 调用方可通过其 reason 区分该情况:
{
"status": "unavailable",
"channel": "msteams",
"accountId": "default",
"reason": "plugin-returned-no-self-identity"
}
联系人(contacts/users)¶
openclaw directory peers list --channel zalouser
openclaw directory peers list --channel zalouser --query "name"
openclaw directory peers list --channel zalouser --limit 50
群组¶
openclaw directory groups list --channel zalouser
openclaw directory groups list --channel zalouser --query "work"
openclaw directory groups members --channel zalouser --group-id <id>
groups members 要求非空 --group-id。空值或仅包含空白字符的 ID 会在插件设置或查询之前失败。
相关¶
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw