Skip to content

Commit 55a1b80

Browse files
authored
feat: add OpenClaw integration guide for OpenIM (#293)
* feat: add OpenClaw integration guide for OpenIM * feat: add OpenClaw integration guide for OpenIM * feat: add OpenClaw integration guide for OpenIM
1 parent 174263c commit 55a1b80

2 files changed

Lines changed: 5 additions & 12 deletions

File tree

docs/guides/solution/openclaw.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,13 @@ sidebar_position: 8
66

77
# 如何接入OpenClaw
88

9-
本文面向使用 OpenIM 的用户,说明如何通过 OpenClaw Gateway 接入 OpenIM,并完成“发送第一条消息”的验证。
9+
本文面向使用 OpenIMSDK 的用户,说明如何通过 OpenClaw Gateway 接入 OpenIMServer,并完成“发送第一条消息”的验证。
1010

1111
## 1. 前置条件
1212

13-
- 你已部署并启动 OpenClaw Gateway,并能在运行 Gateway 的机器上执行 `openclaw` 命令。
14-
- 你已从管理员/运维/业务系统获取以下 OpenIM 连接信息:
15-
- `userID`:OpenClaw 在 OpenIM 中使用的用户 ID
16-
- `wsAddr`:OpenIM SDK WebSocket 地址(例如:`ws://127.0.0.1:10001`
17-
- `apiAddr`:OpenIM REST API 地址(例如:`http://127.0.0.1:10002`
18-
- `platformID`:平台 ID(需与签发该 Token 时使用的 platformID 一致)
13+
- 你已经[部署了OpenIMServer 和 ChatServer](../gettingStarted/dockerCompose),已部署并启动 OpenClaw Gateway,并能在运行 Gateway 的机器上执行 `openclaw` 命令。
1914

20-
## 2. 准备用户 Token
15+
## 2. 注册OpenClaw用户
2116

2217
### 1.注册用户
2318

@@ -32,15 +27,13 @@ sidebar_position: 8
3227

3328

3429

35-
36-
3730
### 获取管理员token
3831

3932
参考 [获取管理员 Token](../../restapi/apis/authenticationManagement/getAdminToken) 文档获取管理员 token。
4033

4134
### 获取用户token
4235

43-
拿到管理员 token 后,参考 [获取用户 Token](../../restapi/apis/authenticationManagement/getUserToken) 文档为指定用户签发登录 token。userID填写刚刚注册的用户的userID,platformID建议填写12
36+
拿到管理员 token 后,参考 [获取用户 Token](../../restapi/apis/authenticationManagement/getUserToken) 文档为指定用户签发登录 token。userID填写刚刚注册的用户的userID,platformID填写12(表示bot)
4437

4538
## 3. 安装 OpenIM Channel 插件
4639

docs/restapi/commonFields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: 常用字段说明
77
| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 |
88
| -------------- | ------ | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
99
| secret | string | 32 | 服务端秘钥 | 字符串 |
10-
| platformID | int | | 用户登录时的终端类型 | 1:iOS, 2:Android, 3:Windows, 4:OSX, 5:Web, 6:MiniWeb, 7:Linux, 8:APad, 9:IPad, 10:Admin, 11:HarmonyOS,12:Bot|
10+
| platformID | int | | 用户登录时的终端类型 | 1:iOS, 2:Android, 3:Windows, 4:OSX, 5:Web, 6:MiniWeb, 7:Linux, 8:APad, 9:IPad, 10:Admin, 11:HarmonyOS|
1111
| userID | string | 64 | 用户ID,保证唯一,不能包含特殊字符 | 字符串 |
1212
| nickname | string | 255 | 昵称 | 字符串 |
1313
| faceURL | string | 255 | 头像URL | URL 链接 |

0 commit comments

Comments
 (0)