community.general.catapult – Отправка SMS/MMS с помощью API catapult bandwidth
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.catapult.
Описание
- Позволяет отправлять уведомления по SMS/MMS через API catapult bandwidth.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_secret строка / обязательно | Секретный ключ API со страницы учетной записи API. | |
| api_token строка / обязательно | Токен API со страницы учетной записи API. | |
| dest список / элементы=строка / обязательно | Номер(а) телефона, на который(е) должно быть отправлено сообщение (должен быть в формате E.164, например: +19195551212). | |
| media строка | Для MMS-сообщений URL медиафайла, расположенного по указанному адресу, который будет отправлен вместе с сообщением. | |
| msg строка / обязательно | Содержание текстового сообщения (не должно превышать 2048 символов). | |
| src строка / обязательно | Один из ваших телефонных номеров catapult, с которого должно быть отправлено сообщение (должен быть в формате E.164, например: +19195551212). | |
| user_id строка / обязательно | Идентификатор пользователя со страницы учетной записи API. |
Примечания
Примечание
- Будет возвращать изменение даже если URL медиафайла неверный.
- Будет возвращать изменение если номер назначения недействителен.
Примеры
- name: Send a mms to multiple users
community.general.catapult:
src: "+15035555555"
dest:
- "+12525089000"
- "+12018994225"
media: "http://example.com/foobar.jpg"
msg: "Task is complete"
user_id: "{{ user_id }}"
api_token: "{{ api_token }}"
api_secret: "{{ api_secret }}"
- name: Send a sms to a single user
community.general.catapult:
src: "+15035555555"
dest: "+12018994225"
msg: "Consider yourself notified"
user_id: "{{ user_id }}"
api_token: "{{ api_token }}"
api_secret: "{{ api_secret }}"
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed булево | всегда | Принимает ли API сообщение. Пример: True |
Авторы
- Jonathan Mainguy (@Jmainguy)
© 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/catapult_module.html