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 10.1.0).

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

Parameters

Parameter

Comments

msg

string / required

The message you would like to send.

msg_type

aliases: message_type

string

Specifies how you would like the message formatted.

Choices:

  • "text" ← (default)

  • "markdown"

personal_token

aliases: token

string / required

Your personal access token required to validate the Webex Teams API.

recipient_id

string / required

The unique identifier associated with the supplied recipient_type.

recipient_type

string / required

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:

  • "roomId"

  • "toPersonEmail"

  • "toPersonId"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

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

message

string

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: "OK (585 bytes)"

status_code

integer

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: 200

Authors

  • Drew Rusell (@drew-russell)