cisco_spark - Отправка сообщения в комнату или к пользователю Cisco Spark.
Новая версия 2.3.
Описание
- Отправка сообщения в комнату или к пользователю Cisco Spark с возможностью управления форматированием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| message обязательно | Сообщение, которое необходимо отправить. | |
| message_type |
| Указывает способ форматирования сообщения. |
| personal_token обязательно | Ваш личный токен доступа, необходимый для проверки API Spark. псевдонимы: токен | |
| recipient_id обязательно | Уникальный идентификатор, связанный с предоставленным recipient_type. | |
| recipient_type обязательно |
| Параметр запроса, для которого необходимо отправить сообщение. Сообщения могут быть отправлены как в комнату, так и к пользователю (по ID или электронной почте). |
Примечания
Примечание
- Тип
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, что означает, что разработчики этого модуля гарантируют, что не будут вноситься изменения в интерфейс, несовместимые со старыми версиями.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/cisco_spark_module.html