community.general.cisco_webex – Отправить сообщение в комнату или к пользователю Cisco Webex Teams

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в книге задач укажите: community.general.cisco_webex

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Отправить сообщение в комнату или к пользователю Cisco Webex Teams с возможностью управления форматированием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
msg строка / обязательно		Сообщение, которое вы хотите отправить. псевдонимы: сообщение
msg_type строка	Варианты: text ← markdown	Указывает, как вы хотите отформатировать сообщение. псевдонимы: тип_сообщения
personal_token строка / обязательно		Ваш личный токен доступа, необходимый для проверки API Webex Teams. псевдонимы: токен
recipient_id строка / обязательно		Уникальный идентификатор, связанный с предоставленным `recipient_type`.
recipient_type строка / обязательно	Варианты: roomId toPersonEmail toPersonId	Параметр запроса, которому вы хотите отправить сообщение. Сообщения могут быть отправлены в комнату или отдельному пользователю (по ID или E-Mail).

Примечания

Примечание

Тип recipient_id должен быть валидным для предоставленного 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 строка	всегда	Сообщение ответа, возвращённое API Webex Teams. Полные объяснения кода ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Пример: OK (585 байт)
status_code целое число	всегда	Код ответа, возвращённый API Webex Teams. Полные объяснения кода ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Пример: 200

Авторы

Drew Rusell (@drew-russell)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/cisco_webex_module.html