ansible.builtin.cisco_spark (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Send a message to a Cisco Spark Room or Individual with options to control the formatting.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

- name: Cisco Spark - Markdown Message to a Room
  cisco_spark:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    message_type: markdown
    personal_token: "{{ token }}"
    message: "**Cisco Spark Ansible Module - Room Message in Markdown**"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Cisco Spark - Text Message to a Room
  cisco_spark:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    message_type: text
    personal_token: "{{ token }}"
    message: "Cisco Spark Ansible Module - Room Message in Text"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Cisco Spark - Text Message by an Individuals ID
  cisco_spark:
    recipient_type: toPersonId
    recipient_id: "{{ person_id}}"
    message_type: text
    personal_token: "{{ token }}"
    message: "Cisco Spark Ansible Module - Text Message to Individual by ID"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Cisco Spark - Text Message by an Individuals E-Mail Address
  cisco_spark:
    recipient_type: toPersonEmail
    recipient_id: "{{ person_email }}"
    message_type: text
    personal_token: "{{ token }}"
    message: "Cisco Spark Ansible Module - Text Message to Individual by E-Mail"

Inputs

    
message:
    description:
    - The message you would like to send.
    required: true

message_type:
    choices:
    - text
    - markdown
    default: text
    description:
    - Specifies how you would like the message formatted.
    required: false

recipient_id:
    description:
    - The unique identifier associated with the supplied C(recipient_type).
    required: true

personal_token:
    aliases:
    - token
    description:
    - Your personal access token required to validate the Spark API.
    required: true

recipient_type:
    choices:
    - roomId
    - toPersonEmail
    - toPersonId
    description:
    - 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).
    required: true

Outputs

message:
  description:
  - The Response Message returned by the Spark API.
  - Full Response Code explanations can be found at U(https://developer.ciscospark.com/endpoint-messages-post.html).
  returned: always
  sample: OK (585 bytes)
  type: str
status_code:
  description:
  - The Response Code returned by the Spark API.
  - Full Response Code explanations can be found at U(https://developer.ciscospark.com/endpoint-messages-post.html).
  returned: always
  sample: 200
  type: int