community.general.cisco_webex 模块 – 向 Cisco Webex Teams 房间或个人发送消息

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.cisco_webex。

概要 

向 Cisco Webex Teams 房间或个人发送消息，并提供控制格式的选项。

别名：cisco_spark

参数 

参数	注释
msg 字符串 / 必需	您要发送的消息。
msg_type 别名：message_type 字符串	指定您希望如何格式化消息。选择 `"text"` ←（默认） `"markdown"`
personal_token 别名：token 字符串 / 必需	您的个人访问令牌，用于验证 Webex Teams API。
recipient_id 字符串 / 必需	与提供的 `recipient_type` 关联的唯一标识符。
recipient_type 字符串 / 必需	您要将消息发送到的请求参数。消息可以发送到房间或个人（通过 ID 或电子邮件）。选择 `"roomId"` `"toPersonEmail"` `"toPersonId"`

属性 

属性	支持	描述
check_mode	支持：完整	可以在 `check_mode` 中运行，并在不修改目标的情况下返回已更改状态的预测。
diff_mode	支持：无	在 diff 模式下，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

注释 

注意

recipient_type 必须对提供的 recipient_id 有效。
完整的 API 文档可以在 https://developer.webex.com/docs/api/basics 上找到。

示例 

# Note: The following examples assume a variable file has been imported
# that contains the appropriate information.

- name: Cisco Webex Teams - Markdown Message to a Room
  community.general.cisco_webex:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    msg_type: markdown
    personal_token: "{{ token }}"
    msg: "**Cisco Webex Teams Ansible Module - Room Message in Markdown**"

- name: Cisco Webex Teams - Text Message to a Room
  community.general.cisco_webex:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Room Message in Text"

- name: Cisco Webex Teams - Text Message by an Individuals ID
  community.general.cisco_webex:
    recipient_type: toPersonId
    recipient_id: "{{ person_id}}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by ID"

- name: Cisco Webex Teams - Text Message by an Individuals E-Mail Address
  community.general.cisco_webex:
    recipient_type: toPersonEmail
    recipient_id: "{{ person_email }}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by E-Mail"

返回值 

常见的返回值记录在此处，以下是此模块特有的字段

键	描述
message 字符串	Webex Teams API 返回的响应消息。完整的响应代码说明可以在 https://developer.webex.com/docs/api/basics 上找到。返回：始终示例： `"OK (585 bytes)"`
status_code 整数	Webex Teams API 返回的响应代码。完整的响应代码说明可以在 https://developer.webex.com/docs/api/basics 上找到。返回：始终示例： `200`

作者

Drew Rusell (@drew-russell)