自定义机器人使用指南
自定义机器人是一种只能在当前群聊中使用的机器人。该类机器人无需管理员在企业后台创建应用,即可在当前群聊中通过调用 webhook 地址的方式完成消息推送。本文主要介绍自定义机器人的使用方式。
注意事项
- 你需要具备一定的服务端开发基础,通过请求调用自定义机器人的 webhook 地址,实现消息推送功能。
- 自定义机器人在添加至群组后即可使用。该特性提升了开发机器人的便携性,但出于数据安全考虑,也限制了自定义机器人的使用场景,自定义机器人不具有任何数据访问权限。如果你希望实现机器人群管理、获取用户信息等能力,建议参考应用机器人。
功能 | 应用机器人 | 自定义机器人 |
---|---|---|
机器人单聊 | ✔ | ❌ |
加入群聊 | ✔ | ✔ |
推送消息 | ✔ | ✔ |
接收消息 | ✔ | ❌ |
群管理以及调用其他丰富的API | ✔ | ❌ |
- 自定义机器人的频率控制和普通应用不同,为5 次/秒。
功能介绍
企业存在给特定群组自动推送消息的场景,例如,推送监控报警、销售线索、运营内容等。在该类场景下,你可以在群组中添加自定义机器人,自定义机器人默认提供 webhook,通过服务端调用 webhook 地址,即可将外部系统的消息通知即时推送到群组中。
自定义机器人消息推送示例,如下图所示:
邀请自定义机器人入群操作步骤
-
进入目标群组,在群组右上角点击 设置 。
-
在右侧设置界面,点击群机器人。
-
在群机器人界面点击添加机器人。
-
在添加机器人对话框,找到自定义机器人或自定义机器人模板Gitlab机器人,并添加。
-
设置自定义机器人的头像、名称与描述,并点击添加。
-
获取自定义机器人的 webhook 地址,并点击完成。成功添加机器人后,查看机器人对应的webhook 地址。请妥善保存好此 webhook 地址,不要公布在博客等可公开查阅的网站上,避免地址泄露后被恶意调用发送垃圾消息。
webhook地址格式:https://host/linker/robot/send?access_token=*********
调用方式
可直接向自定义机器人复制得到的webhook地址发送请求时,支持发送文本、消息卡片等多种消息类型。各类消息类型的请求格式同发送消息的openAPI的请求格式一致。
-
Window(cmd)
curl -k -X POST -H "Content-Type: application/json" -d "{\"msgType\":\"text\",\"body\":\"request example\"}" https://uc4xtest-13.yealink.com:18443/linker/robot/send?access_token=*********
-
postman调用
-
会话内收到通知消息