Spec-Zone.ru › Ansible 2.4

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

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

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

Описание

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

Параметры

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

Примеры

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

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

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

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

Примечания

Примечание

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

Статус

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

Для получения помощи в разработке модулей, если у вас есть желание, прочитайте Информацию о сообществе и о сотрудничестве, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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