Cisco Webex Teams
cisco_webex_teams
通知平台允许您将丰富的通知从 Home Assistant 发送到 Cisco Webex
要使用此通知平台,您需要一个应用程序(机器人)令牌。要获取令牌,请访问 Cisco Webex for Developers
- 详细说明请参见 Webex Teams 机器人文档
中的 创建 Webex 机器人 部分。
您还需要指定希望发送消息的 room_id
。可以通过以下三种方式之一找到 room_id
:
- 登录到 Cisco Webex for Developers
,导航到 Documentation
>API Reference
>Messages
并选择列出消息,或者 - 登录到 web.webex.com
的网页客户端, - 选择房间(或创建一个新房间),
- 然后从 URL 复制房间 ID。
- 在 Webex 客户端中,按 Control+Shift+K(Windows)或 Command+Shift+K(macOS),这将自动将空间信息复制到您的剪贴板,您可以粘贴到记事本中,并且会包含您的空间 ID。
您必须将机器人电子邮件(格式为 mybot@webex.bot
)作为参与者添加到上述指定的房间中。
要在您的安装中启用此平台,请将以下内容添加到您的 configuration.yaml
configuration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下,需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] 文件中。
在更改了configuration.yaml
configuration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下,需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] 文件后,重启 Home Assistant 以应用更改。 该集成现在显示在集成页面的 设置 > 设备与服务 下。其实体在集成卡片上以及实体标签上列出。
# 示例 configuration.yaml 条目
notify:
- name: NOTIFIER_NAME
platform: cisco_webex_teams
token: YOUR_BOT_TOKEN
room_id: CISCO_WEBEX_TEAMS_ROOMID
富文本格式
Webex 客户端可以通过一组白名单中的 html 标签来渲染富文本。
例如,您可以配置自动化以以易于阅读的方式显示详细信息,如下所示:
在 macOS 客户端中显示的富文本。
以下是上述截图的自动化:
# 富文本示例 1。
# 显示一行带红色横幅的消息
- alias: "构建失败时通知"
triggers:
- trigger: webhook
webhook_id: build_failed
actions:
- action: notify.cisco_webex_teams_notify
data:
message: "<blockquote class=danger>构建 0.89.5 编译失败."
# 富文本示例 2。
# 显示带有黄色横幅的标题和多行消息,
# 包含列表、人员提及和链接
- alias: "构建不稳定时通知"
triggers:
- trigger: webhook
webhook_id: build_unstable
actions:
- action: notify.cisco_webex_teams_notify
data:
title: "<strong>构建 0.89.6 不稳定。</strong>"
message: "<blockquote class=warning>版本 0.89.6 验证失败。
<ul>
<li> test_osx
<li> test_win_lint
<li>... 还有 4 个。
</ul>
<p><@personEmail:sparkbotjeeves@sparkbot.io></p>
<p><small><i>查看 <a href='https://demo/testReport/'>测试报告</a></i></small><br></p>
"
# 富文本示例 3。
# 显示带蓝色横幅的标题和多行消息,
# 包含列表、人员提及和链接
- alias: "构建通过时通知"
triggers:
- trigger: webhook
webhook_id: build_passed
actions:
- action: notify.cisco_webex_teams_notify
data:
title: "<strong>✅ 版本 0.89.7 已通过所有测试并部署到生产环境!</strong>"
message: "<blockquote class=info>版本 0.89.7 已通过所有验证。
<ul>
<li> test_cov
<li> test_osx
<li> test_win
<li> test_linux
<li>... 还有 45 个。
</ul>
"
以下是允许的 html 标签和属性的列表:
标签 | 更多信息 |
---|---|
<@personEmail:email@examplecompany.com> |
用于按电子邮件地址标记其他 Webex 团队用户。 |
<a> |
定义超链接。允许属性 href 。 |
<blockquote> |
定义来自另一个来源的引用部分。允许属性 class ,允许值为 danger 、warning 、info 、primary 、secondary 。 |
<b> |
定义粗体文本。 |
<strong> |
定义重要文本。 |
<i> |
定义斜体文本。 |
<em> |
定义强调文本。 |
<pre> |
定义格式化文本。 |
<code> |
定义一段计算机代码。 |
<br> |
定义单行换行。 |
<p> |
定义段落。 |
<ul> |
定义无序列表。 |
<ol> |
定义有序列表。 |
<li> |
定义列表项。 |
<h1> 到 <h3>
|
定义 HTML 标题。 |
要使用通知,请参阅 入门自动化页面。