Spec-Zone.ru › Ansible 2.5

cisco_spark - Отправка сообщения в комнату или к пользователю Cisco Spark.

Новая версия с 2.3.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
message
обязательный
Сообщение, которое вы хотите отправить.
message_type
    Варианты:
  • text ←
  • markdown
Указывает, как вы хотите отформатировать сообщение.
personal_token
обязательный
Ваш личный токен доступа, необходимый для проверки API Spark.

псевдонимы: token
recipient_id
обязательный
Уникальный идентификатор, связанный с предоставленным recipient_type.
recipient_type
обязательный
    Варианты:
  • roomId
  • toPersonEmail
  • toPersonId
Параметр запроса, которому вы хотите отправить сообщение.
Сообщения можно отправлять либо в комнату, либо к пользователю (по идентификатору или электронной почте).

Примечания

Примечание

  • Тип recipient_id должен быть допустимым для предоставленного recipient_id.
  • Полную документацию API можно найти по адресу https://developer.ciscospark.com/endpoint-messages-post.html.

Примеры

# 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**"

- 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"

- 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"

- 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"

Возвращаемые значения

Общие возвращаемые значения описаны в документации, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
message
строка
всегда
Сообщение ответа, возвращаемое API Spark.
Полные объяснения кода ответа можно найти по адресу U(https://developer.ciscospark.com/endpoint-messages-post.html.

Пример:
OK (585 байт)
status_code
целое число
всегда
Код ответа, возвращаемый API Spark.
Полные объяснения кода ответа можно найти по адресу https://developer.ciscospark.com/endpoint-messages-post.html.

Пример:
200


Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Автор

  • 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.5/modules/cisco_spark_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API