community.general.cisco_webex module – Send a message to a Cisco Webex Teams Room or Individual
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.cisco_webex
.
Synopsis
Send a message to a Cisco Webex Teams Room or Individual with options to control the formatting.
Aliases: cisco_spark, notification.cisco_spark, notification.cisco_webex
Parameters
Parameter |
Comments |
---|---|
The message you would like to send. |
|
Specifies how you would like the message formatted. Choices:
|
|
Your personal access token required to validate the Webex Teams API. |
|
The unique identifier associated with the supplied |
|
The request parameter you would like to send the message to. Messages can be sent to either a room or individual (by ID or E-Mail). Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
The
recipient_type
must be valid for the suppliedrecipient_id
.Full API documentation can be found at https://developer.webex.com/docs/api/basics.
Examples
# 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The Response Message returned by the Webex Teams API. Full Response Code explanations can be found at https://developer.webex.com/docs/api/basics. Returned: always Sample: |
|
The Response Code returned by the Webex Teams API. Full Response Code explanations can be found at https://developer.webex.com/docs/api/basics. Returned: always Sample: |